From ac5bbf2b310b13cfe0d4fc0016a916ae64be21e5 Mon Sep 17 00:00:00 2001 From: hnrkndrssn Date: Thu, 6 Jun 2024 10:44:32 +1000 Subject: [PATCH 1/3] chore(docs): add example for specifying package version update description for field to mention not to use single-quotes --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 94686bfe..4b371759 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,23 @@ steps: git_commit: ${{ github.event.after || github.event.pull_request.head.sha }} ``` +To specify the version of a package referenced in a step to use in the release, add the `packages` field: + +```yml +env: + OCTOPUS_API_KEY: ${{ secrets.API_KEY }} + OCTOPUS_URL: ${{ secrets.OCTOPUS_URL }} + OCTOPUS_SPACE: 'Outer Space' +steps: + # ... + - name: Create a release in Octopus Deploy 🐙 + uses: OctopusDeploy/create-release-action@v3 + with: + project: 'MyProject' + packages: | + StepName:PackageReferenceName:Version +``` + ## ✍️ Environment Variables | Name | Description | From 3d4b1a5b2f68743b4ece98c99f5adef34604dbaa Mon Sep 17 00:00:00 2001 From: hnrkndrssn Date: Thu, 6 Jun 2024 10:50:48 +1000 Subject: [PATCH 2/3] chore(docs): update field description --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4b371759..00494a51 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,7 @@ steps: | `release_number` | The number for the new release. If omitted, Octopus Deploy will generate a release number. | | `channel` | The name of the channel to use for the new release. If omitted, the best channel will be selected. | | `package_version` | The version number of all packages to use for this release. | -| `packages` | A multi-line list of version numbers to use for a package in the release. Format: StepName:Version or PackageID:Version or StepName:PackageName:Version. StepName, PackageID, and PackageName can be replaced with an asterisk ("\*"). An asterisk will be assumed for StepName, PackageID, or PackageName if they are omitted. | +| `packages` | A multi-line list of version numbers to use for a package in the release. Format: StepName:Version or PackageID:Version or StepName:PackageName:Version. StepName, PackageID, and PackageName can be replaced with an asterisk ("\*"). An asterisk will be assumed for StepName, PackageID, or PackageName if they are omitted. **NOTE** these values should not be enclosed in single-quotes (`'`) | | `git_ref` | Git branch reference to the specific resources of a version controlled Octopus Project. This is required for version controlled projects. E.g. `${{ github.ref }}` to use the branch or tag ref that triggered the workflow. | | `git_commit` | Git commit pointing to the specific resources of a version controlled Octopus Project. This is required for version controlled projects. E.g. `${{ github.event.after \|\| github.event.pull_request.head.sha }}` to use the commit that triggered the workflow. | | `ignore_existing` | Ignore existing releases if present in Octopus Deploy with the matching version number. Defaults to **false** | From 9d027590c4bb687edd2b5daea1b801735bf00010 Mon Sep 17 00:00:00 2001 From: hnrkndrssn Date: Thu, 6 Jun 2024 10:51:58 +1000 Subject: [PATCH 3/3] chore(docs): add another entry to the packages parameter --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 00494a51..f1e2be2e 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,7 @@ steps: project: 'MyProject' packages: | StepName:PackageReferenceName:Version + PackageID:Version ``` ## ✍️ Environment Variables