馃Ч Update documentation
#147
Merged
Conversation
This file contains 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
pje
reviewed
Jun 2, 2021
CONTRIBUTING.md
Outdated
| ## Releasing a new version | ||
|
|
||
| All the concepts from [the actions/toolkit release docs](https://github.com/actions/toolkit/blob/main/docs/action-versioning.md) apply. Please read that first! | ||
|
|
||
| Once the changes are merged into main, a repo maintainer should: | ||
|
|
||
| 1. Bump the package version by running [`npm version [major|minor|patch]`](https://docs.npmjs.com/cli/v7/commands/npm-version). We adhere to [SemVer 2.0](https://semver.org/spec/v2.0.0.html) to the best of our ability. Commit the changes to `package.json` and `package-lock.json` and push them to main. | ||
| 1. [Draft a new release](https://github.com/actions/labeler/releases/new) pointing to the ref of the version bump you just made. Publish the release to the marketplace when complete. | ||
| 1. Finally: update the most recent "shorthand tag" (v1, v2, v3, etc) to point to the specific ref of the release you just made. For example, if we just released `v1.1.0`, we would rewrite the `v1` tag like this: | ||
|
|
||
| ``` | ||
| git tag -fa v1 v1.1.0 -m "Update v1 tag to point to v1.1.0" | ||
| git push origin v1 --force | ||
| ``` | ||
|
|
There was a problem hiding this comment.
@TingluoHuang How does this sound to you?
There was a problem hiding this comment.
I would like to get @thboop to take a look since I haven't done lots of action releases.
thboop
reviewed
Jun 3, 2021
Co-authored-by: Thomas Boop <52323235+thboop@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
CONTRIBUTING.mdCONTRIBUTING.md(adapted from download-artifact)READMECONTRIBUTING.mdinREADMEREADME.mdandaction.yml