ci(release): Switch from action-prepare-release to Craft #4835
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. New Features ✨
Build / dependencies / internal 🔧Deps
Other
Other
🤖 This preview updates automatically when you update the PR. |
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
| description: Version to release (or "auto") | ||
| required: false |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4835 +/- ##
=======================================
Coverage 73.79% 73.79%
=======================================
Files 483 483
Lines 17551 17551
Branches 3461 3461
=======================================
Hits 12952 12952
Misses 3746 3746
Partials 853 853 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
.github/workflows/release.yml
Outdated
| token: ${{ steps.token.outputs.token }} | ||
| fetch-depth: 0 | ||
| - name: Prepare release | ||
| uses: getsentry/craft@39ee616a6a58dc64797feecb145d66770492b66c # v2 |
There was a problem hiding this comment.
39ee616a6a58dc64797feecb145d66770492b66c has issues with releases, fixed on the latest version
| uses: getsentry/craft@39ee616a6a58dc64797feecb145d66770492b66c # v2 | |
| uses: getsentry/craft@1c58bfd57bfd6a967b6f3fc92bead2c42ee698ce # v2 |
|
|
||
| jobs: | ||
| changelog-preview: | ||
| uses: getsentry/craft/.github/workflows/changelog-preview.yml@v2 |
There was a problem hiding this comment.
Inconsistent Craft version pinning between workflows
Medium Severity
The PR reviewer noted issues with certain Craft versions and recommended pinning to a specific commit hash. The release.yml correctly pins to commit 1c58bfd57bfd6a967b6f3fc92bead2c42ee698ce, but the new changelog-preview.yml uses the mutable @v2 tag instead. If the v2 tag hasn't been updated to the fixed version, or if it later regresses, the changelog-preview workflow could use a problematic version. This inconsistent approach to version pinning goes against the reviewer's guidance.
Additional Locations (1)
.github/workflows/release.yml
Outdated
|
|
||
| - name: Prepare release ${{ github.event.inputs.version }} | ||
| uses: getsentry/action-prepare-release@c8e1c2009ab08259029170132c384f03c1064c0e # v1.6.6 | ||
| uses: getsentry/craft@1c58bfd57bfd6a967b6f3fc92bead2c42ee698ce # v2 |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
|
|
||
| - name: Prepare release ${{ github.event.inputs.version }} | ||
| uses: getsentry/action-prepare-release@c8e1c2009ab08259029170132c384f03c1064c0e # v1.6.6 | ||
| uses: getsentry/craft@c6e2f04939b6ee67030588afbb5af76b127d8203 # v2 |
There was a problem hiding this comment.
Using Craft version with known release issues
High Severity · Bugbot Rules
The PR discussion indicates that the getsentry/craft commit being used has known issues with releases. A reviewer (@lucas-zimerman) suggested using commit 1c58bfd57bfd6a967b6f3fc92bead2c42ee698ce instead, noting that the current version "has issues with releases, fixed on the latest version." This feedback from the PR discussion has not been incorporated.
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.