Add links to release headers #10808
Merged
Add links to release headers #10808
Conversation
This file contains hidden or 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
Member
Author
Collaborator
Builds ready [82d21f8]
Page Load Metrics (580 ± 59 ms)
|
Base automatically changed from
update-release-header-format-and-fix-dates
to
develop
April 2, 2021 20:47
Gudahtt
force-pushed
the
changelog-release-header-links
branch
from
82d21f8 to
b5655d8
Compare
Gudahtt
force-pushed
the
changelog-release-header-links
branch
from
b5655d8 to
f79eb0c
Compare
Collaborator
Builds ready [f79eb0c]
Page Load Metrics (616 ± 46 ms)
|
rekmarks
reviewed
Apr 2, 2021
development/auto-changelog.js
Outdated
| changelogLines.splice(firstReleaseHeaderIndex, 0, versionHeader, ''); | ||
| releaseHeaderIndex = firstReleaseHeaderIndex; | ||
|
|
||
| // Update release links |
Member
There was a problem hiding this comment.
nit: "links" is a confusing reference. It would be better if the comment stated that it's rewriting the Unreleased link and inserting a link for new version.
Member
Author
There was a problem hiding this comment.
To be more specific, it's a link reference definition: https://github.github.com/gfm/#link-reference-definitions
I'll update the comment to better explain this.
Each release header now includes a link to the range of commits included with that release. These links are at the end of the document, in accordance with the "keep a changelog" [1] format. For the purpose of this changelog, the "previous release" is the most recent release mentioned in the changelogs. The diffs ignore any releases that were omitted from the changelog. This is mainly an issue with older releases, so it seemed acceptable. All releases have been documented for a couple of years now, and will be going forward as well. The name of the "Current Develop Branch" section was changed to "Unreleased" to confirm with "keep a changelog". The `auto-changelog.js` script has been updated to update/add these links whenever adding a new release header as well. [1]: https://keepachangelog.com/en/1.0.0/
Gudahtt
force-pushed
the
changelog-release-header-links
branch
from
f79eb0c to
bad85c4
Compare
Collaborator
Builds ready [bad85c4]
Page Load Metrics (531 ± 40 ms)
|
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Each release header now includes a link to the range of commits included with that release. These links are at the end of the document, in accordance with the "keep a changelog" format.
For the purpose of this changelog, the "previous release" is the most recent release mentioned in the changelogs. The diffs ignore any releases that were omitted from the changelog. This is mainly an issue with older releases, so it seemed acceptable. All releases have been documented for a couple of years now, and will be going forward as well.
The name of the "Current Develop Branch" section was changed to "Unreleased" to confirm with "keep a changelog".
The
auto-changelog.jsscript has been updated to update/add these links whenever adding a new release header as well.Relates to #10752
Manual testing steps:
For development changelog updates:
yarn update-changelogFor RC changelog updates with existing release header:
versioninapp/manifest/_base.json, to simulate an RC-like environmentyarn update-changelogUnreleasedlink.For updates without a release header:
versioninapp/manifest/_base.json, to simulate an RC-like environmentyarn update-changelog