Skip to content

fix: Simplify CaC example step in README#689

Open
caitlynstocker wants to merge 1 commit into
mainfrom
cat/devex-374/simplify-cac-examples
Open

fix: Simplify CaC example step in README#689
caitlynstocker wants to merge 1 commit into
mainfrom
cat/devex-374/simplify-cac-examples

Conversation

@caitlynstocker
Copy link
Copy Markdown
Contributor

@caitlynstocker caitlynstocker commented Jun 5, 2026

What's this? 🐦

This simplifies the git_ref and git_commit inputs in our README example step for version-controlled projects.

The old examples contained fallbacks for tag and PR Git refs. Now that Octopus supports all types of Git refs, we can just use ${{ github.ref }} and ${{ github.sha }} and these will resolve to a usable ref no matter the type.

Completes DEVEX-374

@caitlynstocker caitlynstocker requested a review from a team as a code owner June 5, 2026 04:50
@caitlynstocker caitlynstocker changed the title Simplify CaC example step in README fix: Simplify CaC example step in README Jun 5, 2026
@caitlynstocker caitlynstocker requested a review from Copilot June 5, 2026 04:50
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the README’s version-controlled project example to use the standard GitHub Actions context values for git reference and commit, simplifying the configuration for workflows triggered by branches, tags, or pull requests.

Changes:

  • Replaced the previous git_ref expression with ${{ github.ref }} in the README example.
  • Replaced the previous git_commit expression with ${{ github.sha }} in the README example and input documentation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants