Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add backticks around branch in update-release-branch PR template #2138

Merged

Conversation

jsoref
Copy link
Contributor

@jsoref jsoref commented Feb 13, 2024

Most of the replaced content generated by this script are links (SHAs, users, PRs). In general, it's really helpful for non-boilerplate content to be easily recognizable, and links are a good way to do that. As branches come and go, it isn't practical to use links for that purpose, but it is possible to use backticks to call out the branch name.

With these changes, #2131 (comment) would have looked like this:

Merging c79c360 into releases/v3.

Conductor for this PR is ....

Contains the following pull requests:

...

Please do the following:

  • Ensure the CHANGELOG displays the correct version and date.
  • Ensure the CHANGELOG includes all relevant, user-facing changes since the last release.
  • Check that there are not any unexpected commits being merged into the releases/v3 branch.
  • Ensure the docs team is aware of any documentation changes that need to be released.
  • Mark the PR as ready for review to trigger the full set of PR checks.
  • Approve and merge this PR. Make sure Create a merge commit is selected rather than Squash and merge or Rebase and merge.
  • Merge the mergeback PR that will automatically be created once this PR is merged.
  • Merge all backport PRs to older release branches, that will automatically be created once this PR is merged.

And I think that's much more readable -- it's very easy to see that releases/v3 is a branch and interesting as opposed to just prose.

Merge / deployment checklist

  • Confirm this change is backwards compatible with existing workflows.
  • Confirm the readme has been updated if necessary.
  • Confirm the changelog has been updated if necessary.

@jsoref jsoref requested a review from a team as a code owner February 13, 2024 22:05
Copy link
Contributor

@henrymercer henrymercer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks for your contribution!

@henrymercer henrymercer merged commit c6cf6fd into github:main Feb 14, 2024
295 checks passed
@jsoref jsoref deleted the update-release-branch-backticks-for-branch branch February 14, 2024 14:38
@github-actions github-actions bot mentioned this pull request Feb 15, 2024
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants