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}
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}
|
|
||
| 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)
There was a problem hiding this comment.
Seems like we probably should use the commit hash here eh?
There was a problem hiding this comment.
Not really, that would make this way harder to maintain. This is a repo we control so it is safe to use a floating tag.
There was a problem hiding this comment.
Should we not be using a commit hash here then?
I'm OK with either, if we have a good reason, as long as we're consistent.
There was a problem hiding this comment.
Some people were adamant for the relaese job to have hashes. Unfortunately we don't have a standard across repos so do whichever you prefer at this point. I just strongly advice against for the changelog-preview job.
If it was up to me, I'd be using floating tags for both as Craft is a project we control quite strictly.
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.