autotag-from-changelog: Add tag-created and tag outputs#19
autotag-from-changelog: Add tag-created and tag outputs#19fantapop wants to merge 1 commit intocockroachdb:mainfrom
Conversation
Callers can now check whether a new tag was pushed and what it was, enabling downstream steps like release notifications or artifact builds.
There was a problem hiding this comment.
Pull request overview
This PR adds GitHub Action outputs to autotag-from-changelog so callers can detect whether a tag was created and which tag it was, enabling downstream release/build steps.
Changes:
- Add
tag-createdandtagoutputs to theautotag-from-changelogcomposite action and emit them fromauto-tag-release.sh. - Extend integration tests to assert step outputs via a new
expect_outputhelper. - Document the new outputs in
CHANGELOG.md(and a small docs addition inCLAUDE.md).
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| test_helpers.sh | Adds expect_output helper to assert values written to GITHUB_OUTPUT. |
| autotag-from-changelog/auto-tag-release_test.sh | Exports GITHUB_OUTPUT and asserts tag-created / tag outputs in integration tests. |
| autotag-from-changelog/auto-tag-release.sh | Writes tag-created/tag outputs on success/skip paths. |
| autotag-from-changelog/action.yml | Declares composite action outputs and wires them to the step outputs. |
| CLAUDE.md | Adds commit message guidance. |
| CHANGELOG.md | Notes newly exposed action outputs and the new test helper. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| outputs: | ||
| tag-created: | ||
| description: Whether a new tag was created ("true" or "false") | ||
| value: ${{ steps.autotag.outputs.tag-created }} |
There was a problem hiding this comment.
tag-created contains a hyphen, so steps.autotag.outputs.tag-created will be parsed as an expression using subtraction rather than an output lookup. Use bracket notation for that output name (or rename the output to a hyphen-free name like tag_created to keep dot-notation consistent with the other actions in this repo).
| value: ${{ steps.autotag.outputs.tag-created }} | |
| value: ${{ steps.autotag.outputs['tag-created'] }} |
There was a problem hiding this comment.
We should just make this tag_created, the suggestion feels like an overkill
| expect_output() { | ||
| local name="$1" key="$2" expected="$3" | ||
| local actual | ||
| actual=$(grep --fixed-strings "${key}=" "${GITHUB_OUTPUT}" | tail -1 | cut -d= -f2-) | ||
| if [ "$actual" = "$expected" ]; then | ||
| echo "PASS: $name" | ||
| PASS=$((PASS + 1)) | ||
| else | ||
| echo "FAIL: $name — expected output $key=$expected, got '$actual'" | ||
| FAIL=$((FAIL + 1)) | ||
| fi |
There was a problem hiding this comment.
expect_output runs grep | tail | cut under set -euo pipefail (the test files enable this). If the key is missing or $GITHUB_OUTPUT doesn't exist, the pipeline will return non-zero and abort the entire test script instead of recording a FAIL. Consider explicitly handling the missing-key/missing-file case (e.g., check the file exists and make the pipeline non-fatal) so a mismatch increments FAIL like the other helpers.
| GITHUB_OUTPUT="$TMPDIR/github_output" | ||
| export GITHUB_OUTPUT | ||
|
|
There was a problem hiding this comment.
The integration tests reuse a single $GITHUB_OUTPUT file across multiple runs, and expect_output checks the last occurrence of a key. This can cause false positives when a particular invocation fails to write an output at all (a prior run’s value may still be the “last” match). To make the assertions reliably tied to each invocation, truncate or replace $GITHUB_OUTPUT before each script run that you validate outputs for (or otherwise scope the grep to only new lines).
linhcrl
left a comment
linhcrl
left a comment
There was a problem hiding this comment.
Apart from the copilot comments, this looks good to me
Callers can now check whether a new tag was pushed and what it was, enabling downstream steps like release notifications or artifact builds.