Skip to content

Commit

Permalink
docs: note on branching off main when publishing (#1018)
Browse files Browse the repository at this point in the history
This commit adds a note to the CONTRIBUTING documentation to let folks
know that running `npm run publish` will create a new commit on the
current branch and push it up.

This might not be expected so felt that it would be good to explicitly
call out.
  • Loading branch information
woodb authored Mar 16, 2022
1 parent 4183abd commit f867fd4
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@ This can be accomplished with the following command:
$ GH_TOKEN=$GITHUB_TOKEN npm run publish
```

`npm run publish` will push a new commit to the current branch, so _it is
recommended to branch off of `main` prior to doing a new release_ to avoid
pushing directly to `main`.

For more information on using `lerna` to publish, see [the `lerna publish`
documentation](https://github.com/lerna/lerna/tree/main/commands/publish#readme).

Expand Down

0 comments on commit f867fd4

Please sign in to comment.