Skip to content

Commit

Permalink
docs: include defaults info into README
Browse files Browse the repository at this point in the history
  • Loading branch information
bcomnes committed Sep 9, 2020
1 parent 2bd8606 commit 0d25ae4
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,9 @@ The following dependencies and npm lifecycle scripts are recommended for a fully
- `git_email` (**REQUIRED**): The email address used to create the version commit with.
- `git_username` (**REQUIRED**): The name to use for the version commit. e.g. github.actor
- `newversion` (**REQUIRED**): The version bump type to perform (e.g. major, minor, path). See npm version docs for more info. Pass this as an interactive variable.
- `push_version_commit`: Run `git push --follow-tags` after running `npm version`. Enable this if you don't configure a prepublishOnly hook that pushes git commits.
- `skip_test`: 'Skip npm test step. Usually a bad idea, but sometimes not.'
- `publish_cmd`: The command to run after npm version. Useful if you are just using npm to version a package, but not publish to npm (like an action).
- `push_version_commit` (Default: `false`): Run `git push --follow-tags` after running `npm version`. Enable this if you don't configure a prepublishOnly hook that pushes git commits.
- `skip_test` (Default: `false`): 'Skip npm test step. Usually a bad idea, but sometimes not.'
- `publish_cmd` (Default: `npm publish`): The command to run after npm version. Useful if you are just using npm to version a package, but not publish to npm (like an action).
- `github_token`: Pass the secrets.GITHUB_TOKEN to enable gh-release capabilities.
- `npm_token`: An npm token scoped for publishing. Required in most cases. Used to create the release.

Expand Down

0 comments on commit 0d25ae4

Please sign in to comment.