doc: changelog and migration guide for 1.14.0 release #1768
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AgustinBettati
changed the title
AgustinBettati
commented
Dec 18, 2023
| We use a tool called [github changelog generator](https://github.com/github-changelog-generator/github-changelog-generator) to automatically update our changelog. It provides options for downloading a CLI or using a docker image with interactive mode to update the CHANGELOG.md file locally. | ||
|
|
||
| - Update `since_tag` and `future-release` in [.github_changelog_generator](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/.github_changelog_generator) | ||
| - **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 | ||
| - Run the following command: | ||
| ```bash | ||
| 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**" | ||
| 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**" --max-issues 1000 |
There was a problem hiding this comment.
added a --max-issues 1000 config as I was reaching an API rate limit (even when configuring a personal GH token). By default it fetches all (open and closed) issues in the repo (https://github.com/github-changelog-generator/github-changelog-generator/wiki/Advanced-change-log-generation-examples#additional-options)
Zuhairahmed
reviewed
Dec 19, 2023
There was a problem hiding this comment.
Overall pretty good @AgustinBettati, few comments if you can take a look:
marcosuma
reviewed
Dec 19, 2023
marcosuma
reviewed
Dec 19, 2023
marcosuma
reviewed
Dec 19, 2023
marcosuma
reviewed
Dec 19, 2023
marcosuma
reviewed
Dec 19, 2023
marcosuma
reviewed
Dec 19, 2023
marcosuma
reviewed
Dec 19, 2023
marcosuma
reviewed
Dec 19, 2023
marcosuma
reviewed
Dec 19, 2023
marcosuma
reviewed
Dec 19, 2023
RELEASING.md
Outdated
|
|
||
| #### Define the Upgrade Guide | ||
|
|
||
| **Note**: Only applies if the right most version digit is 0. |
There was a problem hiding this comment.
Do you mean the PATCH version here? (https://semver.org/) I think we write an upgrade guide for MINOR
Given a version number MAJOR.MINOR.PATCH, increment the:
MAJOR version when you make incompatible API changes
MINOR version when you add functionality in a backward compatible manner
PATCH version when you make backward compatible bug fixes
Suggested change
| **Note**: Only applies if the right most version digit is 0. | |
| **Note**: Only applies if releasing a MINOR version. |
There was a problem hiding this comment.
Since we are not using sem ver did not want to cause confusion by mentioning terms minor/major, but yes it is referring to a minor version in sem ver standards.
There was a problem hiding this comment.
IMO this is more confusing 🤷 no need to address this comment, just want to flag it
There was a problem hiding this comment.
adding an additional statement clarifying this.
Suggested change
| **Note**: Only applies if the right most version digit is 0. | |
| **Note**: Only applies if the right most version digit is 0 (considered a major or minor version in [semantic versioning](https://semver.org/)). |
lantoli
reviewed
Dec 19, 2023
lantoli
reviewed
Dec 19, 2023
lantoli
reviewed
Dec 19, 2023
lantoli
approved these changes
Dec 19, 2023
lantoli
reviewed
Dec 19, 2023
marcosuma
reviewed
Dec 19, 2023
marcosuma
reviewed
Dec 19, 2023
marcosuma
reviewed
Dec 19, 2023
marcosuma
reviewed
Dec 19, 2023
marcosuma
reviewed
Dec 19, 2023
marcosuma
reviewed
Dec 19, 2023
marcosuma
reviewed
Dec 19, 2023
Zuhairahmed
approved these changes
Dec 19, 2023
|
12 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Link to any related issue(s): CLOUDP-218505
Type of change:
Required Checklist:
Further comments