From 37ae20d75031202d7c094b10a59cfe99de00862a Mon Sep 17 00:00:00 2001 From: Kanad Gupta Date: Mon, 10 Oct 2022 08:07:29 -0600 Subject: [PATCH] docs: create MAINTAINERS.md (#618) * docs: create MAINTAINERS.md * docs: small git push guidance update * chore: remove comment --- MAINTAINERS.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 MAINTAINERS.md diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 000000000..75b6b60ae --- /dev/null +++ b/MAINTAINERS.md @@ -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 `` is the version you wish to update the package to: + +```sh +npm run bump -- +``` + +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 +```