chore: update steps taken to release a new latest tag and version #439
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #439 +/- ##
=======================================
Coverage 99.86% 99.86%
=======================================
Files 7 7
Lines 722 722
=======================================
Hits 721 721
Misses 1 1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
.github/maintainers_guide.md
Outdated
| $ npm version <major|minor|patch> --no-git-tag-version | ||
| ``` | ||
|
|
||
| 4. Update all references to versions in documentation and the workflow files in `example-workflows/` to the latest version: |
There was a problem hiding this comment.
| 4. Update all references to versions in documentation and the workflow files in `example-workflows/` to the latest version: | |
| 4. Update all references to the previous version(s) in documentation and the workflow files in `example-workflows/` to the latest version: |
There was a problem hiding this comment.
idea: Might be a cool place to have a postversion script that updates all examples with the new version. That way, running npm version will automatically update the examples.
There was a problem hiding this comment.
@mwbrooks Thanks for calling out the power of script hooks! 🪄 🪝
This step was updated in 4f5e2f7 to use the version script:
These scripts have access to the new
versionin package.json (so they can incorporate it into file headers in generated files for example).
And now appears as following with the new 7 step release process:
There was a problem hiding this comment.
Wow @zimeg I wish there was an :amaze: 😲 reaction for this!
| ```sh | ||
| $ npm version <major|minor|patch> --no-git-tag-version | ||
| ``` |
.github/maintainers_guide.md
Outdated
| $ npm version <major|minor|patch> --no-git-tag-version | ||
| ``` | ||
|
|
||
| 4. Update all references to versions in documentation and the workflow files in `example-workflows/` to the latest version: |
There was a problem hiding this comment.
idea: Might be a cool place to have a postversion script that updates all examples with the new version. That way, running npm version will automatically update the examples.
Co-authored-by: Ashley <12901850+hello-ashleyintech@users.noreply.github.com> Co-authored-by: Michael Brooks <michael@michaelbrooks.ca>
package.json
Outdated
| @@ -10,7 +10,8 @@ | |||
| "dev": "act public --eventpath .github/resources/.actions/event.json --secret-file .github/resources/.env --platform ubuntu-latest=node:20-buster --container-architecture linux/amd64", | |||
| "lint:fix": "biome check --write", | |||
| "lint": "biome check", | |||
| "test": "c8 mocha test/*.spec.js" | |||
| "test": "c8 mocha test/*.spec.js", | |||
| "version": "TAG=\"v$(npm pkg get version | jq -r)\" && grep -rl 'slackapi/slack-github-action@v' ./docs ./example-workflows | xargs sed -i \"s|slackapi/slack-github-action@v.*|slackapi/slack-github-action@${TAG}|g\"" | |||
There was a problem hiding this comment.
question: Do we want to use version or postversion? The postversion would run this after npm's default version command.
There was a problem hiding this comment.
@mwbrooks Thanks for pointing this out 👁️🗨️ ✨
I was noticing similar behavior with both options, but agree postversion can be more clear that these changes are meant to happen after the packaging updates otherwise.
Avoiding automatic commits and tags for now seems best too - this is stressful magic I find - which could be added to these hooks also at a later point! 🎁
Co-authored-by: Michael Brooks <michael@michaelbrooks.ca>
|
📣 I plan to soon merge this but am also wanting to attempt an actual release process with these steps to find perhaps mishaps before we merge this! |
|
🤖 The @hello-ashleyintech @WilliamBergamin @mwbrooks Thank y'all all so much for the kind reviews and suggestions 🎁 I will now merge this PR but am interested in making the release process even more automatic later. |
Summary
This PR adds the steps taken in the most recent release to the
MAINTAINERS_GUIDE.mdfor future reference 📚 ✨Preview
https://github.com/slackapi/slack-github-action/blob/zimeg-chore-release-notes/.github/maintainers_guide.md#releasing
Requirements