-
Notifications
You must be signed in to change notification settings - Fork 37
Improve release workflow reliability and remove push-protected dependency #1222
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
27f6dd8
Reorganize step order to ensure consistency
Ndpnt eb4fca2
Update dependency
Ndpnt f2adc25
Remove obsolete step
Ndpnt 16e27dd
Lint
Ndpnt 4dac0a9
Explicitly set branch to enable workflow testing
Ndpnt c731ab2
Add changelog entry
Ndpnt File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,7 @@ name: Release | |
|
|
||
| on: | ||
| pull_request_target: | ||
| branches: | ||
| branches: | ||
| - main | ||
| types: [ closed ] | ||
|
|
||
|
|
@@ -21,8 +21,9 @@ jobs: | |
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v2 | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| ref: main | ||
| token: ${{ secrets.RELEASE_BOT_GITHUB_TOKEN }} | ||
|
|
||
| - uses: actions/setup-node@v4 | ||
|
|
@@ -50,24 +51,17 @@ jobs: | |
| git commit -m "Release v${{ steps.release-changelog.outputs.version }}" | ||
| git tag v${{ steps.release-changelog.outputs.version }} | ||
|
|
||
| - name: Run status checks for release commit on temporary branch # Use temporary branch to enable pushing commits to this branch protected by required status checks | ||
| uses: CasperWA/push-protected@v2 | ||
| with: | ||
| token: ${{ secrets.RELEASE_BOT_GITHUB_TOKEN }} | ||
| branch: main | ||
| unprotect_reviews: true | ||
|
|
||
| - name: Update npm | ||
| run: npm install -g npm@latest | ||
|
|
||
| # Publish to NPM first, before pushing to repository | ||
| # If this fails, no changes are pushed to the repository, ensuring consistency | ||
| - name: Publish to NPM public repository | ||
| run: npm publish --provenance | ||
|
|
||
| # Only push to repository after successful NPM publish | ||
| - name: Push changes to repository | ||
| run: git push origin && git push --tags | ||
| run: git push origin main && git push --tags | ||
|
|
||
| - name: Create GitHub release | ||
| uses: softprops/action-gh-release@v1 | ||
| uses: softprops/action-gh-release@v2 | ||
| with: | ||
| tag_name: v${{ steps.release-changelog.outputs.version }} | ||
| body: ${{ steps.release-changelog.outputs.content }} | ||
|
|
@@ -88,6 +82,7 @@ jobs: | |
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| ref: main | ||
| token: ${{ secrets.RELEASE_BOT_GITHUB_TOKEN }} | ||
|
|
||
| - name: Configure Git author | ||
|
|
@@ -101,4 +96,4 @@ jobs: | |
| - name: Save changelog | ||
| run: | | ||
| git commit -m "Clean changelog" CHANGELOG.md | ||
| git push origin | ||
| git push origin main | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👍 very good hardening to not rely on branch name matching! |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For security, as long as GitHub does not provide immutable releases, using the full SHA is the only way to prevent supply chain attacks.