Add docs for nuget source override variable (#3053)

grace-rehn · web-flow · commit 3d5b05e383f8 · 2026-03-06T10:16:07.000+10:00
* Add docs for nuget source override variable

* Lint
diff --git a/src/pages/docs/projects/variables/system-variables.md b/src/pages/docs/projects/variables/system-variables.md
@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2025-05-12
+modDate: 2026-03-06
 title: System variables
 icon: fa-solid fa-desktop
 description: System variables are variables provided by Octopus that can be used in your deployments.
@@ -10,7 +10,7 @@ navOrder: 20
 
 This page lists built-in [variables](/docs/projects/variables/) provided by Octopus that can be used in your deployment [custom scripts](/docs/deployments/custom-scripts).
 
-Most of the variables listed here are available in modern versions of Octopus and Calamari. However, some are only available from a specific version. See [Older versions](#older-versions) for more detail on when variables became available. 
+Most of the variables listed here are available in modern versions of Octopus and Calamari. However, some are only available from a specific version. See [Older versions](#older-versions) for more detail on when variables became available.
 
 :::div{.warning}
 **All variables are strings**
@@ -62,12 +62,12 @@ Packages, including changes, associated with the release. See below. This is a c
 
 Build and version control details associated with the release. This is a collection.
 
-:::div{.hint} 
+:::div{.hint}
 
 The `Octopus.Release.Package` and `Octopus.Release.Builds` variables:
 
-* will only be populated if [build information](/docs/packaging-applications/build-servers/build-information) has been pushed from the build server.  
-* is only available to be used by the project [release notes](/docs/releases/release-notes), it is not accessible from the project deployment steps.
+- will only be populated if [build information](/docs/packaging-applications/build-servers/build-information) has been pushed from the build server.  
+- is only available to be used by the project [release notes](/docs/releases/release-notes), it is not accessible from the project deployment steps.
 
 :::
 
@@ -101,30 +101,30 @@ public class Commit
 
 The packages in a release are available as a collection which can be [iterated over](/docs/projects/variables/variable-substitutions/#repetition).  e.g.
 
-```
+```text
 #{each package in Octopus.Release.Package}
     This release contains #{package.PackageId} #{package.Version}
 #{/each}
 ```
 
 A particular package can be selected by indexing on the package ID:
 
-```
+```text
 #{Octopus.Release.Package[Acme.Web].Version}
 ```
 
 The variables available for packages are:
 
-| Name | Example|
-| -------------------- | -------|
-|`PackageId`| `#{package.PackageId}` |
-|`Version`| `#{package.Version}` |
-|`Commits`| This is a collection.  See below. |
-|`WorkItems`| This is a collection.  See below. |
+| Name        | Example                           |
+| ----------- | --------------------------------- |
+| `PackageId` | `#{package.PackageId}`            |
+| `Version`   | `#{package.Version}`              |
+| `Commits`   | This is a collection.  See below. |
+| `WorkItems` | This is a collection.  See below. |
 
 On each package, the commits associated with that package are available as a collection which can be iterated over. e.g.:
 
-```
+```text
 #{each package in Octopus.Release.Package}
 #{each commit in package.Commits}
 - [#{commit.CommitId}](#{commit.LinkUrl}) - #{commit.Comment}
@@ -134,42 +134,42 @@ On each package, the commits associated with that package are available as a col
 
 A particular commit can be selected by indexing on the commit ID (when using git the commit ID is the commit hash):
 
-```
+```text
 package.Commits[685afd4161d085e6e5f56a66e72e2298e402b114].Comment
 ```
 
 The variables available for commits are:
 
-| Name | Example|
-| -------------------- | -------|
-|`CommitId`| `#{commit.CommitId}` |
-|`LinkUrl`| `#{commit.LinkUrl}` |
-|`Comment`| `#{commit.Comment}` |
+| Name       | Example                |
+| ---------- | ---------------------- |
+| `CommitId` | `#{commit.CommitId}`   |
+| `LinkUrl`  | `#{commit.LinkUrl}`    |
+| `Comment`  | `#{commit.Comment}`    |
 
 If the Octopus instance has one or more of the [Issue Tracker integrations](/docs/releases/issue-tracking) enabled, the commit messages will be parsed for issues. Any issues found will be displayed with the build information, and also available as variables:
 
-```
+```text
 #{each issue in package.WorkItems}
 - [#{issue.Id}](#{issue.LinkUrl})
 #{/each}
 ```
 
 A particular issue can be selected by indexing on the ID:
 
-```
+```text
 package.WorkItems[4465].LinkUrl
 ```
 
 The variables available for issues are:
 
-| Name | Example|
-| -------------------- | -------|
-|`Id`| `#{issue.Id}` |
-|`LinkUrl`| `#{issue.LinkUrl}` |
+| Name      | Example            |
+| --------- | ------------------ |
+| `Id`      | `#{issue.Id}`      |
+| `LinkUrl` | `#{issue.LinkUrl}` |
 
 There is also a distinct list of issues across all packages available in:
 
-```
+```text
 #{each workItem in Octopus.Release.WorkItems}
 - [#{workItem.Id}](#{workItem.LinkUrl}) - #{workItem.Description}
 #{/each}
@@ -202,15 +202,15 @@ public class BuildPackage
 
 The builds in a release are available as a collection which can be [iterated over](/docs/projects/variables/variable-substitutions/#repetition).  e.g.
 
-```
+```text
 #{each build in Octopus.Release.Builds}
     This release contains resources contributed by the build #{build.BuildUrl}
 #{/each}
 ```
 
 Builds have a zero-based integer index, meaning the first build can be selected at index 0:
 
-```
+```text
 Octopus.Release.Builds[0].BuildUrl
 ```
 
@@ -289,21 +289,21 @@ Example: `#{build.Packages[0].Version}`
 For projects that have [version control](/docs/projects/version-control) enabled, information about the branch and commit from which the release was created is also available.
 
  `Octopus.Release.Git.BranchName`
- 
+
  The branch name.
- 
+
  Example: *features/some-new-feature*
 
  `Octopus.Release.Git.CommitHash`
- 
- The commit hash. 
- 
+
+ The commit hash.
+
  Example: *0c708fdec272bc4446c6cabea4f0022c2b616eba*
 
  `Octopus.Release.Git.Ref`
- 
+
  The git reference.
- 
+
  Example: *Version 1*
 
 ## Deployment
@@ -432,15 +432,15 @@ Example: *Tenant type/External, Upgrade ring/Early adopter*
 
 `Octopus.Deployment.Trigger.Id`
 
-The ID of the Trigger that created the deployment.  It is possible for a deployment to be triggered due to multiple triggers. In this case, the variable will contain the ID of _one_ of the triggers.
+The ID of the Trigger that created the deployment.  It is possible for a deployment to be triggered due to multiple triggers. In this case, the variable will contain the ID of *one* of the triggers.
 
 Example: *ProjectTriggers-522*
 
 `Octopus.Deployment.Trigger.Name`
 
-The name of the Trigger that created the deployment. It is possible for a deployment to be triggered due to multiple triggers. In this case, the variable will contain the name of _one_ of the triggers.
+The name of the Trigger that created the deployment. It is possible for a deployment to be triggered due to multiple triggers. In this case, the variable will contain the name of *one* of the triggers.
 
-*Nightly Deploy to Dev*
+Example: *Nightly Deploy to Dev*
 
 `Octopus.Deployment.WorkerLeaseCap`
 
@@ -748,11 +748,12 @@ public class CommitDetails
     public string Comment { get; set; }
 }
 ```
+
 There is an entry per release and it includes the release notes (**in markdown format**) and the build information for each of the packages in that release.
 
 **Example:** The following iterates the changes in the deployment, printing the release version and the issues contained.
 
-```
+```text
 #{each change in Octopus.Deployment.Changes}
     #{change.Version}
     #{each issue in change.WorkItems}
@@ -907,6 +908,12 @@ The syntax of the script being run in a script step.
 
 Example: *PowerShell*
 
+`Octopus.Action.Script.CSharp.NuGetSource`
+
+Overrides the NuGet source used by the dotnet executor when running C# script steps.
+
+Example: *<https://my-nuget-server/nuget>*
+
 `Octopus.Action.SkipRemainingConventions`
 
 If set by the user, completes processing of the action without running further conventions/scripts *(Boolean)*. This should be set as an [output variable](/docs/projects/variables/output-variables). e.g. <br /> `Set-OctopusVariable -name 'Octopus.Action.SkipRemainingConventions' -value 'True'`
@@ -1109,7 +1116,7 @@ Example: *True*
 
 The Storage URI of the \*.cspkg file that will be deployed to the Cloud Service.
 
-Example: https://my-storage-account/container/my-cloudservice.web.cspkg
+Example: <https://my-storage-account/container/my-cloudservice.web.cspkg>
 
 `Octopus.Action.Azure.UseCurrentInstanceCount`
 
@@ -1209,15 +1216,15 @@ Example: *alice*
 
 `Octopus.Action[_name_].Output.OctopusAzureCloudServiceDeploymentID`
 
-The ID of the completed Azure Cloud Service deployment. 
+The ID of the completed Azure Cloud Service deployment.
 
 Example: *c9f52da2b00a4313b3b64bb2ad0f409f*
 
 `Octopus.Action[_name_].Output.OctopusAzureCloudServiceDeploymentUrl`
 
 The Url of the completed Azure Cloud Service deployment.
 
-Example: *http://c9f52da2b00a4313b3b64bb2ad0f409f.cloudapp.net/*
+Example: *<http://c9f52da2b00a4313b3b64bb2ad0f409f.cloudapp.net/>*
 
 ## Step
 
@@ -1259,7 +1266,6 @@ If the step failed because of an error, a full description of the error.
 
 Example: *System.Net.SocketException: The server could not be contacted (at ...)*
 
-
 ## Agent
 
 Agent-level variables describe the deployment agent or Tentacle on which the deployment is executing.
@@ -1316,7 +1322,7 @@ Example: *[https://my-octopus](https://my-octopus)*
 
 `Octopus.Web.ServerUri`
 
-The default URL at which the server portal can be accessed, as configured in the **Configuration ➜ Nodes** settings. 
+The default URL at which the server portal can be accessed, as configured in the **Configuration ➜ Nodes** settings.
 
 *[https://my-octopus](https://my-octopus)*
 
@@ -1382,7 +1388,7 @@ Example: *3/13/20 6:23:38 AM +00:00*
 
 The branch name if the runbook run was created from a branch
 
-*branch-abc*
+Example: *branch-abc*
 
 `Octopus.RunbookRun.Git.CommitHash`
 
@@ -1424,7 +1430,7 @@ Example: *RunbookSnapshots-123*
 
 The name of the snapshot.
 
-*Snapshot EXAMPLE3*
+Example: *Snapshot EXAMPLE3*
 
 `Octopus.RunbookSnapshot.Notes`
 
@@ -1480,11 +1486,10 @@ Example: True
 
 `OctopusFreeDiskSpaceOverrideInMegaBytes`
 
-The amount (in megabytes) of available free disk space we should check for (overriding the default 500MB), failing the deployment if not enough free disk space is available. 
+The amount (in megabytes) of available free disk space we should check for (overriding the default 500MB), failing the deployment if not enough free disk space is available.
 
 Example: 100
 
-
 `OctopusShouldFailDeploymentOnSubstitutionFails`
 
 If set to "True", the deployment will fail if any variable substitution fails. This variable was added in Octopus 2025.1.0.
@@ -1505,7 +1510,7 @@ Example: False
 
 `Octopus.Action.Script.SuppressEnvironmentLogging`
 
-To suppress/disable the environment logging that occurs from script (eg. PowerShell or Bash Script Environment Variables logging). This only suppresses script logging and does not suppress the Octopus or Calamari environment logging. 
+To suppress/disable the environment logging that occurs from script (eg. PowerShell or Bash Script Environment Variables logging). This only suppresses script logging and does not suppress the Octopus or Calamari environment logging.
 
 Example: True
 
@@ -1523,7 +1528,7 @@ Example: True
 
 `Octopus.Action.Package.RunScripts`
 
-Set to `false` to prevent scripts inside packages from executing. 
+Set to `false` to prevent scripts inside packages from executing.
 
 Example: True
 
@@ -1549,9 +1554,10 @@ Octopus will run one task at a time for a given concurrency tag. Set the variabl
 Example: #{Octopus.Deployment.Tenant.Id}/#{Octopus.Project.Id}/#{Octopus.Environment.Id}
 
 ## Older versions {#older-versions}
-* `Octopus.Release.Git.BranchName`, `Octopus.Release.Git.CommitHash` and `Octopus.Release.Git.Ref` is available from Octopus Deploy **2021.3** onwards.
-* `Octopus.Web.ServerUri` is available from Octopus Deploy **2019.4.0** onwards.
-* `Octopus.Deployment.Tenant.Id`, `Octopus.Deployment.Tenant.Name` and `Octopus.Deployment.Tenant.Tags` is available from Octopus Deploy **3.4** onwards.
+
+- `Octopus.Release.Git.BranchName`, `Octopus.Release.Git.CommitHash` and `Octopus.Release.Git.Ref` is available from Octopus Deploy **2021.3** onwards.
+- `Octopus.Web.ServerUri` is available from Octopus Deploy **2019.4.0** onwards.
+- `Octopus.Deployment.Tenant.Id`, `Octopus.Deployment.Tenant.Name` and `Octopus.Deployment.Tenant.Tags` is available from Octopus Deploy **3.4** onwards.
 
 ## Learn more
 
