diff --git a/README.md b/README.md index 4e364950..0bd3d9e4 100644 --- a/README.md +++ b/README.md @@ -56,8 +56,8 @@ steps: uses: OctopusDeploy/create-release-action@v4 with: project: 'MyProject' - git_ref: ${{ (github.ref_type == 'tag' && github.event.repository.default_branch ) || (github.head_ref || github.ref) }} - git_commit: ${{ github.event.after || github.event.pull_request.head.sha }} + git_ref: ${{ github.ref }} + git_commit: ${{ github.sha }} ``` To specify the version of a package referenced in a step to use in the release, add the `packages` field: @@ -97,7 +97,7 @@ steps: | `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 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. | +| `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.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. |