Ephemeral environments docs refresh#3251
Merged
Merged
Conversation
caitlynstocker
force-pushed
the
cat/bass-618/ee-docs-refresh
branch
from
July 22, 2026 05:55
ca07d12 to
534cbcb
Compare
caitlynstocker
changed the title
caitlynstocker
commented
Jul 22, 2026
| :::div{.warning} | ||
| Support for providing custom fields is not yet available in the Octopus CLI. | ||
| ::: | ||
|
|
Contributor
Author
There was a problem hiding this comment.
Support for custom fields was added to the CLI in this PR.
There was a problem hiding this comment.
Pull request overview
This PR refreshes the Ephemeral Environments documentation to improve clarity and navigability (including for AI agents), primarily through wording tweaks and small structural adjustments.
Changes:
- Refined Ephemeral Environments project docs wording and reordered a key “configured” statement for better flow.
- Clarified Ephemeral Environments concepts in the infrastructure overview page.
- Simplified the Channels “Custom fields” section by removing the Early Access Preview note and rewriting the intro.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/pages/docs/releases/channels/index.md | Rewords the “Custom fields” section and removes the Early Access Preview hint. |
| src/pages/docs/projects/ephemeral-environments/index.md | Improves readability/flow and clarifies behavior around environment creation and naming. |
| src/pages/docs/infrastructure/ephemeral-environments/index.md | Refines the high-level description of how releases and runbooks relate to ephemeral environments. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
caitlynstocker
commented
Jul 22, 2026
|  | ||
|
|
||
| Ephemeral environments are now configured for your project. A new channel has been created in the project to manage the creation and deployment of ephemeral environments. | ||
|
|
Contributor
Author
There was a problem hiding this comment.
Not true until you click 'Got it' below.
caitlynstocker
commented
Jul 22, 2026
| **Tips:** | ||
|
|
||
| - Environment names only support a specific set of characters, Octopus will automatically replace the following invalid characters with a `-`: `< > : " / \ | ? * { }` | ||
| - Environment names only support a specific set of characters, Octopus will automatically replace the following invalid characters with a dash: `< > : " / \ | ? * { }` |
Contributor
Author
There was a problem hiding this comment.
Only because this reads clearer for me.
caitlynstocker
force-pushed
the
cat/bass-618/ee-docs-refresh
branch
from
July 22, 2026 06:20
534cbcb to
57715ff
Compare
caitlynstocker
commented
Jul 22, 2026
|
|
||
| :::div{.hint} | ||
| Support for custom fields in releases is rolling out to Octopus Cloud in Early Access Preview. | ||
| ::: |
Contributor
Author
There was a problem hiding this comment.
We've been in GA since the start of the year 👍
caitlynstocker
commented
Jul 22, 2026
| When auto deployment is configured, Octopus will automatically create a new ephemeral environment for you from releases in your project. A pattern for naming environments can be configured using an Environment Name Template. Templates support the same powerful syntax as Variables. Any [system variable for a release](/docs/projects/variables/system-variables#release) can be used as part of the template. | ||
|
|
||
| When auto deployment is not configured, you need to manually create ephemeral environments and deploy releases to them. You can do this using the Octopus Portal, API and CLI. | ||
| You can also select to manually create and deploy to an environment. |
Contributor
Author
There was a problem hiding this comment.
The way this line followed on from the previous one, it sounded like a separate option but it's actually not.
caitlynstocker
commented
Jul 22, 2026
| - [Octopus CLI](/docs/octopus-rest-api/cli) | ||
|
|
||
| To manually create an ephemeral environment in the Octopus portal, visit the Ephemeral Environments page within the project then: | ||
|
|
Contributor
Author
There was a problem hiding this comment.
Linter wants a new line 🤷♀️
caitlynstocker
force-pushed
the
cat/bass-618/ee-docs-refresh
branch
2 times, most recently
from
July 22, 2026 06:51
96a5441 to
844d633
Compare
caitlynstocker
marked this pull request as ready for review
July 22, 2026 06:53
caitlynstocker
force-pushed
the
cat/bass-618/ee-docs-refresh
branch
from
July 22, 2026 06:58
844d633 to
42eafcf
Compare
adam-mccoy
approved these changes
Jul 22, 2026
|
Pull request environment is available at https://stoctodocspr3251.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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What's this? 🐦
This PR refreshes our ephemeral environments documentation as part of a push to make EE more easily navigable by AI agents. (This partly just me nitpicking the wording for clarity.)
How to review? 🔍
🧪 Run
pnpm devto preview the changes locally☑️ Let me know if anything is unclear and I'll fix it up!
Completes BMBB-618