Add publish/release instructions #148
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
joshbetz
reviewed
Jul 12, 2018
CONTRIBUTING.md
Outdated
|
|
||
| ### Major / Minor Versions | ||
|
|
||
| 1. Set the version: `npm version minor` or `npm version major` |
There was a problem hiding this comment.
You most likely usually want npm version patch or npm version minor. I suspect it will be a while before we do a 2.0.0.
joshbetz
reviewed
Jul 12, 2018
CONTRIBUTING.md
Outdated
|
|
||
| ### Patch Version | ||
|
|
||
| For a critical fix, we can `git checkout` a previous release and cherry-pick or apply specific changes. This is especially useful for security releases and if there are already some bigger changes in the master branch and you don't want to push a normal release. |
There was a problem hiding this comment.
Also useful if there's a security fix and we want to patch multiple minor versions. 1.0.0 -> 1.0.1 and 1.1.0 -> 1.1.1 for example.
mjangda
commented
Jul 13, 2018
CONTRIBUTING.md
Outdated
|
|
||
| ## Releasing | ||
|
|
||
| Note: We use `publish-release` for some pre-publish confidence checks to avoid common mistakes. |
There was a problem hiding this comment.
Should add some details about the prepareConfig:publish and why we use prepack for it.
Including considerations for config and clearer details on patching.
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.
No description provided.