Updating release-notes tool to account for new changelog format #309
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
camscale
approved these changes
Jan 21, 2025
There was a problem hiding this comment.
LGTM, but...
I'm not sure this is going to be needed because I think the changelogs are now unmaintainable so I would want to revert the change that adds the later changelogs to an earlier release branch.
That said, there is no harm to this change - maybe it may be useful to generate an old github release for some reason?
| @@ -21,3 +27,17 @@ Teleport 16 brings the following new features and improvements: | |||
| - Access requests from the resources view | |||
| - `tctl` for Windows | |||
| - Teleport plugins improvements | |||
|
|
|||
| ## 15.4.17 (08/28/24) | |||
There was a problem hiding this comment.
Perhaps add a test for this version so that there is a test where the changelog is terminated by EOF and not the next heading? Or just remove this section so that the test for v16 does that?
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.
The format of our CHANGELOG has changed a bit for release branches. Previously, the latest version of the release branch was expected to be the first second-level header.
e.g. for branch/v16 with the latest release being v16.0.1 the first second-level header encountered would be
## 16.0.1The format of the CHANGELOG for our release branches now includes all released versions. Now the first second-level header will be the latest released version of Teleport and the patches for other releases will be located further down in the CHANGELOG.
To account or this the release-notes tool will now search for the correct version in the CHANGELOG to populate the release notes.