Skip to content

Add hyperlink in the release changelog#11241

Merged
frouioui merged 1 commit intovitessio:mainfrom
planetscale:hyperlink-changelog
Sep 28, 2022
Merged

Add hyperlink in the release changelog#11241
frouioui merged 1 commit intovitessio:mainfrom
planetscale:hyperlink-changelog

Conversation

@frouioui
Copy link
Member

Description

This Pull Request changes the release notes generation script to natively include a link for each Pull Request in the change log. This way, the users reading the change log can quickly click and see the Pull Request associated with a change.

Related Issue(s)

Checklist

  • "Backport me!" label has been added if this change should be backported
  • Tests were added or are not required
  • Documentation was added or is not required

Deployment Notes

@vitess-bot
Copy link
Contributor

vitess-bot bot commented Sep 16, 2022

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • If this is a change that users need to know about, please apply the release notes (needs details) label so that merging is blocked unless the summary release notes document is included.
  • If a new flag is being introduced, review whether it is really needed. The flag names should be clear and intuitive (as far as possible), and the flag's help should be descriptive. Additionally, flag names should use dashes (-) as word separators rather than underscores (_).
  • If a workflow is added or modified, each items in Jobs should be named in order to mark it as required. If the workflow should be required, the GitHub Admin should be notified.

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should either include a link to an issue that describes the bug OR an actual description of the bug and how to reproduce, along with a description of the fix.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • vtctl command output order should be stable and awk-able.

Copy link
Contributor

Choose a reason for hiding this comment

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

why did we need this?

Copy link
Member Author

Choose a reason for hiding this comment

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

It does basically the same thing and the release branches are already using [0-9] instead of \d.

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Sep 28, 2022

I was unable to backport this Pull Request to the following branches: release-14.0.

frouioui added a commit to planetscale/vitess that referenced this pull request Sep 28, 2022
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
frouioui added a commit that referenced this pull request Sep 28, 2022
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing hyperlinks to the release change logs

3 participants