-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* docs: create MAINTAINERS.md * docs: small git push guidance update * chore: remove comment
- Loading branch information
1 parent
8d0af81
commit 37ae20d
Showing
1 changed file
with
36 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Maintainers | ||
|
||
This doc describes how to prep a release and publish to GitHub and `npm`. | ||
|
||
## Prep the Release | ||
|
||
Run the following command, where `<version>` is the version you wish to update the package to: | ||
|
||
```sh | ||
npm run bump -- <version> | ||
``` | ||
|
||
This command will automatically bump the version in the `package.json` and the `package-lock.json` files, as well as add the corresponding tags. | ||
|
||
## Publishing to GitHub :octopus: | ||
|
||
The next step is to push these changes to GitHub: | ||
|
||
```sh | ||
git push # pushes the code | ||
git push --tags # pushes the tags | ||
``` | ||
|
||
## Publishing to `npm` :rocket: | ||
|
||
Finally, publish the changes to `npm`. If you're publishing to the default [distribution tag](https://docs.npmjs.com/adding-dist-tags-to-packages) (i.e. `latest`), you can run the following: | ||
|
||
```sh | ||
npm publish | ||
``` | ||
|
||
If you're publishing to another [distribution tag](https://docs.npmjs.com/adding-dist-tags-to-packages) for prelease purposes or otherwise (e.g., `alpha`, `beta`, `next`, etc.), include the tag like so: | ||
|
||
```sh | ||
npm publish --tag <tag> | ||
``` |