Add doc for environment state - #3319
Conversation
yangguoif
changed the title
|
Pull request environment is available at https://stoctodocspr3319.z22.web.core.windows.net. You can view the ephemeral environment status in Octopus Deploy. This environment will be automatically deprovisioned when the pull request is closed, or after 7 days of inactivity. |
75be84c to
746257b
Compare
geofflamrock
left a comment
geofflamrock
left a comment
There was a problem hiding this comment.
This looks pretty good, I've left a few small suggestions and questions, happy to pair on working through anything here.
Co-authored-by: Geoff Lamrock <geoff.lamrock@gmail.com>
Co-authored-by: Geoff Lamrock <geoff.lamrock@gmail.com>
geofflamrock
left a comment
geofflamrock
left a comment
There was a problem hiding this comment.
Looks good and is pretty much ready to go I think. I've left a few final thoughts after a second read-through and we may end up wanting to adjust some of that screenshot but this prob doesn't need another look at we can just do those and merge when ready.
|
|
||
| ## Using environment state | ||
|
|
||
| Octopus makes each state entry available as a [variable](/docs/projects/variables) named `Octopus.Environment.State[key]` in later deployment or runbook run, where `key` is the name you set. |
There was a problem hiding this comment.
Could it be worth a line here like, 'Unlike other variables in Octopus, state entries will not appear listed on your project's variables page.'?
There was a problem hiding this comment.
At the moment this doc is under /environments, so imho we should not mix variables into this. The environment state is just injected into script as "variable" for the execution, but itself is not a type of variable. Adding this line may actually confuse reader?
I will leave it as it is for now, if we would like to clarify this bit later, we can always update the doc 😃
4 participants
Background
BMBB-661 : Support for Environment State is added into Octopus, we should update related doc in Environment and Ephemeral Environment.
What's changed
This PR
How to review
Proof reading is highly appreciated. Please checkout the preview built by CI (after CI shows green tick), recommend starting from
docs/projects/ephemeral-environments#environment-urls, clicking the link to check the doc related to Environment State.