Skip to content

Commit a3b9386

Browse files
committed
docs: add note about npm versioning
1 parent 3e6f99e commit a3b9386

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

.github/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,8 @@ yarn test
8585

8686
A GitHub Action has been developed to help automate package releases. All that you will need to do is:
8787

88-
1. Make sure to increase the `version` field in the **package.json**
88+
1. Make sure to increase the `version` field in the **package.json**. `npm version [major | minor | patch]` will handle the versioning and commit for you.
8989
2. On the GitHub repo's home page, navigate to the righthand side and click on **Create a new release**
9090
3. Give the release a `title` and `description` outlining the changes made in the release
9191
4. Choose/Create a **tag** corresponding to the new version that was added in the package.json in **step 1**
92-
5. Once the details are filled out, submit the release. You will get taken to a confirmation page. This process will automatically trigger the GitHub action that will publish the package to npm.
92+
5. Once the details are filled out, submit the release. You will get taken to a confirmation page. This process will automatically trigger the GitHub action that will publish the package to npm.

0 commit comments

Comments
 (0)