Skip to content

Commit

Permalink
chore(maintainers): add gh release script + docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kanadgupta committed Dec 16, 2022
1 parent 7bcaeb9 commit d197242
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
9 changes: 6 additions & 3 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,13 @@ git push --tags -f # 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`).
Make sure you have the [GitHub CLI](https://cli.github.com) installed and then run the following:

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.
```sh
npm run release:gh
```

This will create a draft release which you can enhance before publishing. I like to summarize the changes and note any highlights in a blurb above the auto-generated release notes. These release links are nice for sharing with customers, on socials, etc.

## Publishing to `npm` :rocket:

Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@
"prettier:write": "prettier --list-different --write \"./**/**.{md,js,ts}\"",
"preversion": "npm ci && npm run build",
"release": "npx conventional-changelog-cli -i CHANGELOG.md -s",
"release:gh": "gh release create $npm_package_version --draft --generate-notes",
"test": "jest --coverage",
"version": "npm run release && git add CHANGELOG.md"
},
Expand Down

0 comments on commit d197242

Please sign in to comment.