Skip to content

Commit 2e69786

Browse files
Update channels page with ephemeral environments information (#2881)
* Update channels page with ephemeral environments * For substantial edits, we should update the modified date --------- Co-authored-by: Steve Fenton <99181436+steve-fenton-octopus@users.noreply.github.com>
1 parent dcaa8d3 commit 2e69786

File tree

1 file changed

+33
-7
lines changed
  • src/pages/docs/releases/channels

1 file changed

+33
-7
lines changed

src/pages/docs/releases/channels/index.md

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: src/layouts/Default.astro
33
pubDate: 2023-01-01
4-
modDate: 2025-09-23
4+
modDate: 2025-10-28
55
title: Channels
66
icon: fa-solid fa-arrows-split-up-and-left
77
description: Channels allow you to dynamically change the deployment logic and lifecycle of a project based on the version being deployed.
@@ -33,15 +33,41 @@ Channels are managed from the Projects page by selecting the specific project yo
3333

3434
As you add more channels, you'll notice that they are arranged in alphabetical order on the channels page.
3535

36-
## Create a new channel
36+
### Channel Types
37+
38+
There are two types of channel:
39+
- Lifecycle channels: Releases in this channel will progress through the lifecycle defined for the channel.
40+
- Ephemeral Environment channels: Releases in this channel will be deployed to ephemeral environments. The environment will be provisioned automatically when it is first deployed to. A project can only have one ephemeral environment channel.
41+
42+
## Create a new lifecycle channel
43+
44+
1. From the Channels page, click on the **Add Channel** button.
45+
2. Select **Lifecycle** for the channel type
46+
3. Give the channel a name and add a description. The channel name must be unique within the project.
47+
4. Select the [lifecycle](/docs/releases/lifecycles/) the channel will use, or allow the channel to inherit the default lifecycle for the project. See the [lifecycle docs](/docs/releases/lifecycles) for information about creating new lifecycles.
48+
5. If you want to make this the default channel for the project, click the **Default channel** check-box.
49+
6. Configure the [channel rules](#channel-rules).
50+
- [Package version](#version-rules) will be used to enforce which versions of your packages are deployed to this channel
51+
- [Git protection rules](#git-protection-rules) will be used to control the use of files from Git repositories during deployments
52+
7. Configure any [custom fields](#custom-fields) you want to require when creating releases in this channel.
53+
54+
## Create a new ephemeral environment channel
55+
56+
Ephemeral Environment channels are designed to work with [ephemeral environments](/docs/projects/ephemeral-environments). When a release is deployed to an ephemeral environment channel, the environment will be provisioned automatically if it does not already exist.
3757

3858
1. From the Channels page, click on the **Add Channel** button.
39-
2. Give the channel a name and add a description. The channel name must be unique within the project.
40-
3. Select the [lifecycle](/docs/releases/lifecycles/) the channel will use, or allow the channel to inherit the default lifecycle for the project. See the [lifecycle docs](/docs/releases/lifecycles) for information about creating new lifecycles.
59+
2. Select **Ephemeral Environment** for the channel type
60+
3. Give the channel a name and add a description. The channel name must be unique within the project.
4161
4. If you want to make this the default channel for the project, click the **Default channel** check-box.
42-
5. Design the [version rules](#version-rules) that will be used to enforce which versions of your packages are deployed to this channel.
62+
5. Select the [parent environment](/docs/projects/ephemeral-environments#parent-environment).
63+
6. Select whether you want to [automatically deploy](/docs/projects/ephemeral-environments#auto-deploy) to the environment when a release is created.
64+
7. Provide a [name template](/docs/projects/ephemeral-environments#naming) for the ephemeral environment.
65+
8. Configure the [channel rules](#channel-rules).
66+
- [Package version](#version-rules) will be used to enforce which versions of your packages are deployed to this channel
67+
- [Git protection rules](#git-protection-rules) will be used to control the use of files from Git repositories during deployments
68+
9. Configure any [custom fields](#custom-fields) you want to require when creating releases in this channel.
4369

44-
## Channel rules
70+
### Channel rules
4571

4672
Channels allow to you to configure rules to ensure that package versions and Git resources that meet specific criteria can be deployed using the channel.
4773

@@ -264,4 +290,4 @@ The image below shows an example dashboard with discrete channel release enabled
264290

265291
## Removing channels
266292

267-
For projects using Config as Code, it's up to you to take care to avoid deleting any channels required by your deployments. See our [core design decisions](/docs/projects/version-control/unsupported-config-as-code-scenarios#core-design-decision) for more information.
293+
For projects using Config as Code, it's up to you to take care to avoid deleting any channels required by your deployments. See our [core design decisions](/docs/projects/version-control/unsupported-config-as-code-scenarios#core-design-decision) for more information.

0 commit comments

Comments
 (0)