Skip to content

Commit

Permalink
Update docs to clarify usage of git_ref and git_commit arguments (#526)
Browse files Browse the repository at this point in the history 
* chore(docs): Update docs to clarify usage of git_ref and git_commit arguments

* Apply suggestions from code review

Co-authored-by: Isaac Calligeros <101079287+IsaacCalligeros95@users.noreply.github.com>

---------

Co-authored-by: Isaac Calligeros <101079287+IsaacCalligeros95@users.noreply.github.com>
  • Loading branch information
@hnrkndrssn @IsaacCalligeros95
hnrkndrssn and IsaacCalligeros95 authored Jan 28, 2025
1 parent a9554c8 commit 949b796
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,8 @@ steps:
| `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. **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. |
| `git_ref` | Git reference, _branch name or tag_, to the specific resources of a version controlled Octopus Project. This should be used for version controlled projects when OCL files are stored in a different repository or branch as the application being built. E.g. Use the `main` branch, regardless of the location of the repository where the application(s) are being built as they are different **or** `${{ github.ref }}` to use the branch or tag ref that triggered the workflow. |
| `git_commit` | Git commit, _commit SHA-1 hash_, pointing to the specific resources of a version controlled Octopus Project. This should be used for version controlled projects when OCL files are stored in the same repository or branch as the application being built. 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** |
| `release_notes` | The release notes text associated with the new release (Markdown is supported). |
| `release_notes_file` | A file containing the release notes associated with the new release (Markdown is supported). Use either `release_notes` or this input, supplying both is not supported. |
Expand Down

0 comments on commit 949b796

Please sign in to comment.