Use the same format as GitHub's default for the release notes #4926
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
github-actions
bot
added
the
changelog:repository
We're changing the format for the auto-generated release notes from: - This is the PR title #1 (@author) to: * This is the PR title by @author in solidusio#1 By mimicking the default GitHub format, we make it easier to generate them manually through GitHub's "Generate release notes" [1] button or through the API [2]. At the same time, we're fixing the missing links to the PR when we copy the draft content to the Changelog file, as GitHub doesn't autolink references in files. From their documentation [3]: > Note: Autolinked references are not created in wikis or files in a repository. We'll still miss the link to the contributor, but it's a tradeoff we pay to make our lives easier if the automation fails. Anyway, it can be accessed once landed on the pull request URL. [1] - https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes [2] - https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#generate-release-notes-content-for-a-release [3] - https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-url Closes solidusio#4904 & solidusio#4908
waiting-for-dev
force-pushed
the
waiting-for-dev/adopt_changelog_format_from_gh
branch
from
b70cd0b to
1879d0d
Compare
3 tasks
waiting-for-dev
commented
Feb 9, 2023
elia
approved these changes
Feb 9, 2023
adammathys
approved these changes
Feb 9, 2023
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.
Summary
Use the same format as GitHub's default for the release notes
We're changing the format for the auto-generated release notes from:
to:
By mimicking the default GitHub format, we make it easier to generate them manually through GitHub's "Generate release notes" button or through the API.
At the same time, we're fixing the missing links to the PR when we copy the draft content to the Changelog file, as GitHub doesn't autolink references in files. From their documentation:
We'll still miss the link to the contributor, but it's a tradeoff we pay to make our lives easier if the automation fails. Anyway, it can be accessed once landed on the pull request URL.
Closes #4904 & #4908
Checklist
Check out our PR guidelines for more details.
The following are mandatory for all PRs:
The following are not always needed: