ci(release): Switch from action-prepare-release to Craft #3069
Conversation
This PR migrates from the deprecated action-prepare-release to the new Craft GitHub Actions (reusable workflow or composite action). Changes: - Migrate .github/workflows/release.yml to Craft reusable workflow
Semver Impact of This PR🟢 Patch (bug fixes) 📋 Changelog PreviewThis is how your changes will appear in the changelog. Build / dependencies / internal 🔧
Other
🤖 This preview updates automatically when you update the PR. |
The previous migration incorrectly removed the GitHub App token authentication step. This commit restores it by switching to the composite action pattern which preserves the auth flow.
![sentry[bot]](https://avatars.githubusercontent.com/u/1396951?s=60&v=4){kind=small}
| permissions: | ||
| contents: write | ||
| pull-requests: write |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
szokeasaurusrex
left a comment
szokeasaurusrex
left a comment
There was a problem hiding this comment.
We already discussed this over Slack, but please undo these extraneous version comments 🙏 then I will properly review this 😄
- Remove changelog-preview.yml as requested by reviewer - Restore original version comments (remove duplicate # vX # X.Y.Z) - Restore original formatting and runner in release.yml - Remove unnecessary permissions from GHCR workflows (keep only packages: write)
| version: | ||
| description: Version to release | ||
| required: true | ||
| description: Version to release (or "auto") | ||
| required: false |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
| version: ${{ github.event.inputs.version }} | ||
| force: ${{ github.event.inputs.force }} | ||
| merge_target: ${{ github.event.inputs.merge_target }} | ||
| version: ${{ inputs.version }} |
There was a problem hiding this comment.
Bug: The optional version input passes an empty string when omitted, not the "auto" string required by the Craft action for auto-detection, causing release failures.
Severity: HIGH
Suggested Fix
To align the behavior with the description, set a default value for the input: default: "auto". This ensures that if a user omits the version input, the Craft action correctly receives "auto" and triggers the intended auto-detection logic.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: .github/workflows/release.yml#L38
Potential issue: The `version` input in the `release.yml` workflow was changed to be
optional (`required: false`) with a description suggesting that omitting it enables
auto-detection. However, when a user does not provide a value, GitHub Actions passes an
empty string (`""`) to the workflow. The downstream `getsentry/craft` action expects the
literal string `"auto"` to trigger its auto-versioning logic. Since it receives an empty
string instead, the release process will likely fail or behave incorrectly, contrary to
the documented behavior.
Did we get this right? 👍 / 👎 to inform future reviews.
Summary
This PR migrates from the deprecated
action-prepare-releaseto the new Craft GitHub Actions.Changes
.github/workflows/release.ymlto Craft reusable workflowDocumentation
See https://getsentry.github.io/craft/github-actions/ for more information.