Skip to content
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

Package reference docker image variables #2587

Merged
merged 2 commits into from
Dec 17, 2024
Merged

Package reference docker image variables #2587

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7b2ab15
Updated run a script step package reference variables to include spec…
tleed5 Dec 10, 2024
087c1f1
Merge branch 'main' into tl/update-package-reference-variables
tleed5 Dec 10, 2024
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
11 changes: 11 additions & 0 deletions src/pages/docs/deployments/custom-scripts/run-a-script-step.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,17 @@ If the package reference was _not_ configured to be extracted, then the un-extra

These locations were designed to be convenient for use from custom scripts, as the relative path can be predicted, e.g. `./Acme` or `./Acme.zip`. If the absolute path is required the variables above may be used.

#### Docker image package variables
In the scenario where your package reference is a Docker image some additional variables will be contributed. These variables are (assuming a package-reference named `Acme`):

| Variable name and description | Example |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is missing Octopus.Action.Package[Acme].Image.Label[Foo] since the functionality is broken due to OctopusDeploy/Issues#9163 and OctopusDeploy/Issues#9164

|--------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|
| `Octopus.Action.Package[Acme].Image` <br/>The fully qualified image name | *index.docker.io/Acme:1.4.0* |
| `Octopus.Action.Package[Acme].Registry` <br/>The URI of the registry from the feed where the image was acquired from | *index.docker.io* |
| `Octopus.Action.Package[Acme].Version` <br/>The version of the image included in the release | *1.4.0* |
| `Octopus.Action.Package[Acme].Feed.UserName` <br/>The username from the feed where the image was acquired from (if the feed is configured to use credentials) | *Alice* |
| `Octopus.Action.Package[Acme].Feed.Password` <br/>The password from the feed where the image was acquired from (if the feed is configured to use credentials) | *Password01!* |

## Older versions

Scripts sourced from your Projects Git Repository was added in Octopus **2024.1**. In Octopus versions prior, the Git Repository source is not available.
Loading