Skip to content

Commit

Permalink
docs: update maintainers guidance
Browse files Browse the repository at this point in the history
  • Loading branch information
kanadgupta committed Nov 17, 2022
1 parent 5ed84a0 commit 1aa7214
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Run the following command, where `<version>` is the version you wish to update t
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.
This command will automatically bump the version in the `package.json` and the `package-lock.json` files, update [`CHANGELOG.md`](./CHANGELOG.md), and add the corresponding git tags.

## Publishing to GitHub :octopus:

Expand All @@ -21,9 +21,16 @@ git push # pushes the code
git push --tags # pushes the tags
```

Once the code and tags are pushed to GitHub, [create a new release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release) so the latest tag is surfaced in [the GitHub Marketplace listing](https://github.com/marketplace/actions/rdme-sync-to-readme).

> **Note**
> When selecting the tag to associate the release with, use the one **without** the `v` prefix (e.g., `8.0.0`, not `v8.0.0`).
Auto-generating release notes is sufficient, but I like to summarize the changes and note any highlights in a blurb above those notes. These release links are nice for sharing with customers, on socials, etc.

## 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:
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
Expand Down

0 comments on commit 1aa7214

Please sign in to comment.