forked from vultix/ts-results
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move the package publishing documentation out of readme (#149)
Continuing the work started in [1] for easier documentation consumption and maintenance. [1] 633ccad ("Set up an initial documentation structure (#81)")
- Loading branch information
Showing
3 changed files
with
20 additions
and
14 deletions.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
Publishing the package | ||
====================== | ||
|
||
The package is published manually right now. | ||
|
||
Steps to publish: | ||
|
||
1. Bump the version in ``package.json`` and ``src/package.json`` as needed | ||
2. Update the CHANGELOG | ||
3. Commit to Git in a single commit and add a tag: ``git tag -a vX.X.X`` (the tag description can be | ||
anything) | ||
4. ```npm run build && npm publish``` | ||
5. Push both the ``master`` branch and the new tag to GitHub |
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