Skip to content

Commit

Permalink
release.md: Fix "npm run" examples by adding '--' (#24100)
Browse files Browse the repository at this point in the history
  • Loading branch information
mcsf committed Jul 21, 2020
1 parent f619af3 commit 1130044
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/contributors/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,12 @@ npm run changelog

By default, this will search for and organize all pull requests associated with the milestone for the next version of the project.

To override the default behavior, you can pass one or both of the following options:
To override the default behavior, you can pass one or both of the following options. Remember to use `--` to let NPM pass the options to the script.

- `--milestone <milestone>`: Provide the title of the milestone for which the changelog should be generated. This should exactly match the title as shown on [the milestones page](https://github.com/WordPress/gutenberg/milestones).
- Example: `npm run changelog --milestone="Gutenberg 8.1"`
- Example: `npm run changelog -- --milestone="Gutenberg 8.1"`
- `--token <token>`: Provide a [GitHub personal access token](https://github.com/settings/tokens) for authenticating requests. This should only be necessary if you run the script frequently enough to been blocked by [rate limiting](https://developer.github.com/v3/#rate-limiting).
- Example: `npm run changelog --token="..."`
- Example: `npm run changelog -- --token="..."`

The script will output a generated changelog, grouped by pull request label. _Note that this is intended to be a starting point for release notes_. You will still want to manually review and curate the changelog entries.

Expand Down

0 comments on commit 1130044

Please sign in to comment.