Skip to content

Update channels page with ephemeral environments information #2881

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 31, 2025
Merged

Update channels page with ephemeral environments information #2881

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad84588
Update channels page with ephemeral environments
lourens-octopus Oct 21, 2025
084c949
For substantial edits, we should update the modified date
steve-fenton-octopus Oct 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 33 additions & 7 deletions src/pages/docs/releases/channels/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2025-09-23
modDate: 2025-10-28
title: Channels
icon: fa-solid fa-arrows-split-up-and-left
description: Channels allow you to dynamically change the deployment logic and lifecycle of a project based on the version being deployed.
Expand Down Expand Up @@ -33,15 +33,41 @@ Channels are managed from the Projects page by selecting the specific project yo

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

## Create a new channel
### Channel Types

There are two types of channel:
- Lifecycle channels: Releases in this channel will progress through the lifecycle defined for the channel.
- 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.

## Create a new lifecycle channel

1. From the Channels page, click on the **Add Channel** button.
2. Select **Lifecycle** for the channel type
3. Give the channel a name and add a description. The channel name must be unique within the project.
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.
5. If you want to make this the default channel for the project, click the **Default channel** check-box.
6. Configure the [channel rules](#channel-rules).
- [Package version](#version-rules) will be used to enforce which versions of your packages are deployed to this channel
- [Git protection rules](#git-protection-rules) will be used to control the use of files from Git repositories during deployments
7. Configure any [custom fields](#custom-fields) you want to require when creating releases in this channel.

## Create a new ephemeral environment channel

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.

1. From the Channels page, click on the **Add Channel** button.
2. Give the channel a name and add a description. The channel name must be unique within the project.
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.
2. Select **Ephemeral Environment** for the channel type
3. Give the channel a name and add a description. The channel name must be unique within the project.
4. If you want to make this the default channel for the project, click the **Default channel** check-box.
5. Design the [version rules](#version-rules) that will be used to enforce which versions of your packages are deployed to this channel.
5. Select the [parent environment](/docs/projects/ephemeral-environments#parent-environment).
6. Select whether you want to [automatically deploy](/docs/projects/ephemeral-environments#auto-deploy) to the environment when a release is created.
7. Provide a [name template](/docs/projects/ephemeral-environments#naming) for the ephemeral environment.
8. Configure the [channel rules](#channel-rules).
- [Package version](#version-rules) will be used to enforce which versions of your packages are deployed to this channel
- [Git protection rules](#git-protection-rules) will be used to control the use of files from Git repositories during deployments
9. Configure any [custom fields](#custom-fields) you want to require when creating releases in this channel.

## Channel rules
### Channel rules

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.

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

## Removing channels

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.
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.