doc: how to create a new release. #18
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
legendecas
reviewed
Mar 31, 2023
| * Use the output generated by **changelog maker** to update the | ||
| [CHANGELOG.md][] following the style used in publishing the previous release. | ||
|
|
||
| * Add any new contributors to the "contributors" section in the |
There was a problem hiding this comment.
I didn't find steps to create git tags for the release. Should we document that the tag should be created along with package.json version updates by npm version patch or npm version minor?
There was a problem hiding this comment.
The tag will be created by GitHub while creating new release.
This will be address doing this step:
- Create a release in Github (look at existing releases for an example).
legendecas
approved these changes
Mar 31, 2023
| * Use the output generated by **changelog maker** to update the | ||
| [CHANGELOG.md][] following the style used in publishing the previous release. | ||
|
|
||
| * Add any new contributors to the "contributors" section in the |
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.
Suggestion cannot be applied right now. Please check back later.
This PR add the guide that explain how to create and publish a new release.