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

[docs] Add PR number to the release notes entry #22665

Conversation

steveburnett
Copy link
Contributor

@steveburnett steveburnett commented May 3, 2024

Description

Update pull_request_template.md to recommend including the new PR number as part of the release note entry.

The Release Notes Guidelines have been edited to reflect this change.

Motivation and Context

Reviewing the release note entries as part of the release cycle and manually editing the individual release note entries to include the PR the entry is sourced from takes significant work as part of the release notes process. By asking the individual developer to include the PR number in their release notes entry, the release notes process should be quicker.

Impact

The pull request authoring process.

Test Plan

CI

Contributor checklist

  • Please make sure your submission complies with our development, formatting, commit message, and attribution guidelines.
  • PR description addresses the issue accurately and concisely. If the change is non-trivial, a GitHub Issue is referenced.
  • Documented new properties (with its default value), SQL syntax, functions, or other functionality.
  • If release notes are required, they follow the release notes guidelines.
  • Adequate tests were added if applicable.
  • CI passed.

Release Notes

Please follow release notes guidelines and fill in the release notes below.

== RELEASE NOTES ==

General Changes
* Add PR number to the release note entry examples in pull_request_template.md :pr:`22665`

@steveburnett steveburnett requested a review from a team as a code owner May 3, 2024 19:45
@steveburnett steveburnett self-assigned this May 3, 2024
@steveburnett steveburnett merged commit be20d29 into prestodb:master May 3, 2024
56 checks passed
@steveburnett steveburnett deleted the steveburnett-pull-request-template branch May 3, 2024 20:45
@steveburnett
Copy link
Contributor Author

After I merged this approved PR, I pushed a test branch and opened a new PR to production-test the update to the PR template.

Screenshot shows the result:
Screenshot 2024-05-03 at 4 43 57 PM

@rschlussel
Copy link
Contributor

It would be nice if we could have the release notes script do this automatically instead of relying on people to do this manually.

@steveburnett
Copy link
Contributor Author

It would be nice if we could have the release notes script do this automatically instead of relying on people to do this manually.

That would be nice! I can open an issue for the automatic solution, and this change to the template asking people to do so manually should help in the interim.

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