slackapi/slack-github-action
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add in testing instructions for maintainer's guide and standardize bullet point punctuation (#140)

Browse Source 
* Update maintainer's guide to include testing note

* standardize bullet punctuation
This commit is contained in:
Ashley
2022-10-12 12:24:21 -04:00
committed by GitHub
parent 60532b0844
commit 4466b609d3
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/maintainers_guide.md
+7 -6
View File
@@ -23,13 +23,14 @@ Actions jobs that execute what are effectively integration tests for this GitHub
- If all issues have been closed, continue with the release.
- If issues are still open, discuss with the team about whether the open issues should be moved to a future release or if the release should be held off until the issues are resolved.
- Take a look at all issues under the Milestone to make sure that the type of issues included aligns with the Milestone name based on [semantic versioning](https://semver.org/). If the issues do not align with the naming of the Milestone (ex: if the issues are all bug fixes, but the Milestone is labeled as a minor release), then you can tweak the Milestone name to reflect the correct versioning.
* Update the version in `package.json`
* Update all references to versions in the README and in the workflow files under `example-workflows/` to refer to the latest release
* Commit the changes
* Create a git tag for the new version. Should be in the format `v1.4.0`. `git tag v1.4.0`
* Push changes up to GitHub `git push origin main --tags`
* Update the version in `package.json`.
* Update all references to versions in the README and in the workflow files under `example-workflows/` to refer to the latest release.
* Run all tests using `npm test` to make sure the tests pass.
* Commit the changes on your `main` branch.
* Create a git tag for the new version. Should be in the format `v1.4.0`. `git tag v1.4.0`.
* Push changes up to GitHub `git push origin main --tags`.
* Create a GitHub Release based on the tag you just pushed up - this will trigger the publishing
GitHub workflow
GitHub workflow.
* Once released, make sure to close the relevant GitHub Milestone for the version you released.
## Workflow