Skip to content

Commit a29d523

Browse files
fix: Update github generator command to include breaking changes (#1661)
1 parent bfaf2cc commit a29d523

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

RELEASING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ We use a tool called [github changelog generator](https://github.com/github-chan
2727
- **There is a bug with `github_changelog_generator` ([#971](https://github.com/github-changelog-generator/github-changelog-generator/issues/971))**: Make sure to update the `future-tag` with the pre-release tag. Once you generate the changelog, update `future-tag` with the final release tag in [.github_changelog_generator](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/.github_changelog_generator). Then, manually update the generated changelog to remove references to the pre-release tag
2828
- Run the following command:
2929
```bash
30-
docker run -it --rm -v "$(pwd)":/usr/local/src/your-app githubchangeloggenerator/github-changelog-generator -u mongodb -p terraform-provider-mongodbatlas -t <GH_TOKEN> --enhancement-label "**Enhancements**" --bugs-label "**Bug Fixes**" --issues-label "**Closed Issues**" --pr-label "**Internal Improvements**"
30+
docker run -it --rm -v "$(pwd)":/usr/local/src/your-app githubchangeloggenerator/github-changelog-generator -u mongodb -p terraform-provider-mongodbatlas -t <GH_TOKEN> --breaking-labels "breaking-change" --enhancement-label "**Enhancements**" --bugs-label "**Bug Fixes**" --issues-label "**Closed Issues**" --pr-label "**Internal Improvements**"
3131
```
3232
To obtain your github personal access token you can use the following guide: [Authorizing a personal access token for use with SAML single sign-on](https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)
3333
- Create a JIRA ticket and open a PR against the **master** branch. Make any manual adjustments if needed taking into account date format and format parameter names and resources/data source names if they begin with `mongodbatlas`.

0 commit comments

Comments
 (0)