Skip to content

Commit f1fdd73

Browse files
committed
Improve docs for custom fields
1 parent e3f4333 commit f1fdd73

File tree

5 files changed

+40
-4
lines changed

5 files changed

+40
-4
lines changed
33.7 KB
Loading
74.4 KB
Loading

src/pages/docs/projects/variables/system-variables.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,13 @@ The date and time at which the release was created.
4545

4646
Example: *Tuesday 10th September 1:23 PM*
4747

48+
`Octopus.Release.CustomFields[_name_]`
49+
50+
The value of a custom field set on a release.
51+
52+
Example: *4587* for a custom field `Pull Request Number`
53+
Example: *TST-123* for a custom field `Jira Ticket Number`
54+
4855
### Release package build information {#release-package-build-information}
4956

5057
`Octopus.Release.Package`

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

Lines changed: 17 additions & 1 deletion
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-02-18
4+
modDate: 2025-09-23
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.
@@ -153,6 +153,22 @@ Some examples:
153153
![Advanced patterns example](/docs/img/releases/channels/images/project-repository.png)
154154
:::
155155

156+
## Custom fields {#custom-fields}
157+
158+
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+
![Screenshot of editing custom fields for a channel showing a custom field for a Pull Request Number](/docs/img/releases/channels/images/channel-custom-fields.png)
170+
:::
171+
156172
## Using channels {#using-channels}
157173

158174
Once a project has more than one channel, there a number of places they may be used.

src/pages/docs/releases/creating-a-release.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: src/layouts/Default.astro
33
pubDate: 2024-04-29
4-
modDate: 2025-09-03
4+
modDate: 2025-09-23
55
title: Creating a release
66
description: Learn how to create a release in Octopus Deploy
77
navOrder: 2
@@ -121,9 +121,23 @@ Releases can have custom fields added to them when being created. Custom fields
121121
- During deployments within scripts and other steps.
122122

123123
:::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.
125125
:::
126126

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+
![Screenshot of Octopus release page showing entering the value of a custom field for a Pull Request Number](/docs/img/releases/images/create-release-custom-fields.png)
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+
127141
The following restrictions apply to custom fields on releases:
128142

129143
- 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:
133147

134148
The following limitations apply to custom fields during the Early Access Preview:
135149

136-
- Specifying specific custom fields as required on a release is not supported.
137150
- Support for providing custom fields is not yet available in the Octopus CLI.

0 commit comments

Comments
 (0)