You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Channels allow you to define which custom fields are required when creating a release within the channel, ensuring you can use them within scripts and steps in the deployment process.
159
+
160
+
:::div{.hint}
161
+
Support for custom fields in releases is rolling out Octopus Cloud in Early Access Preview.
162
+
:::
163
+
164
+
1. When viewing a channel, click **Add Custom Field** in the Custom Fields section.
165
+
2. Enter a name and description for the field.
166
+
3. Click **Save**.
167
+
168
+
:::figure
169
+

170
+
:::
171
+
156
172
## Using channels {#using-channels}
157
173
158
174
Once a project has more than one channel, there a number of places they may be used.
Copy file name to clipboardExpand all lines: src/pages/docs/releases/creating-a-release.md
+16-3Lines changed: 16 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
layout: src/layouts/Default.astro
3
3
pubDate: 2024-04-29
4
-
modDate: 2025-09-03
4
+
modDate: 2025-09-23
5
5
title: Creating a release
6
6
description: Learn how to create a release in Octopus Deploy
7
7
navOrder: 2
@@ -121,9 +121,23 @@ Releases can have custom fields added to them when being created. Custom fields
121
121
- During deployments within scripts and other steps.
122
122
123
123
:::div{.hint}
124
-
Support for custom fields on releases is rolling out Octopus Cloud in Early Access Preview as part of the Ephemeral Environments feature.
124
+
Support for custom fields on releases is rolling out Octopus Cloud in Early Access Preview.
125
125
:::
126
126
127
+
### Required custom fields
128
+
129
+
Channels can define which custom fields are required when creating a release within the channel. The Octopus Web Portal will prompt to set any required custom fields when creating a release. Learn more about [configuring custom fields in channels](/docs/releases/channels).
130
+
131
+
:::figure
132
+

133
+
:::
134
+
135
+
### Using custom fields in scripts and steps
136
+
137
+
Custom fields can be used within scripts and steps with the variable `#{Octopus.Release.CustomFields[_name_]}`.
138
+
139
+
### Restrictions
140
+
127
141
The following restrictions apply to custom fields on releases:
128
142
129
143
- A maximum of 10 custom fields can be added to each release.
@@ -133,5 +147,4 @@ The following restrictions apply to custom fields on releases:
133
147
134
148
The following limitations apply to custom fields during the Early Access Preview:
135
149
136
-
- Specifying specific custom fields as required on a release is not supported.
137
150
- Support for providing custom fields is not yet available in the Octopus CLI.
0 commit comments