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

Release Tooling Project: Build generate-pr-description script that generates a PR description for a Release PR #22601

Closed
13 tasks
Tracked by #22532
JReinhold opened this issue May 17, 2023 · 1 comment · Fixed by storybookjs/monorepo-release-tooling-prototype#31
Assignees

Comments

@JReinhold
Copy link
Contributor

JReinhold commented May 17, 2023

  • generates the PR description for the Release PR
  • not really useful locally, except for a todo list
  • Will generate a different kind of description if no versioning is necessary

Example for version bumps

This is an automated pull request that bumps the version from 7.1.0-alpha.10 to 7.1.0-alpha.11. Once this pull request is merged, it will trigger a new release of version 7.1.0-alpha.11. If you're not a core maintainer with permissions to release you can ignore this pull request.

To do

Before merging the PR, there are a few QA steps to go through:

  • Add the "freeze" label to this PR, to ensure it doesn't get automatically forced pushed by new changes.

And for each change below:

  1. Ensure the change is appropriate for the version bump. E.g. patch release should only contain patches, not new or de-stabilizing features. If a change is not appropriate, revert the PR.
  2. Ensure the PR is labeled correctly with "BREAKING CHANGE", "feature request", "maintainance", "bug", "build" or "documentation".
  3. Ensure the PR title is correct, and follows the format "[Area]: [Summary]", e.g. "React: Fix hooks in CSF3 render functions". If it is not correct, change the title in the PR.
    • Areas include: React, Vue, Core, Docs, Controls, etc.
    • First word of summary indicates the type: “Add”, “Fix”, “Upgrade”, etc.
    • The entire title should fit on a line

This is a list of all the PRs merged and commits pushed directly to next, that will be part of this release:

If you needed to make any changes doing the above QA (change PR titles, revert PRs), manually trigger a re-generation of this PR with this workflow and wait for it to finish. It will wipe your progress in this to do, which is expected.

When everything above is done:


Generated changelog

7.1.0-alpha.11

Example without version bumps

This is an automated pull request. None of the changes requires a version bump, they are only internal or documentation related. Merging this PR will not trigger a new release, but documentation will be updated.
If you're not a core maintainer with permissions to release you can ignore this pull request.

This is a list of all the PRs merged and commits pushed directly to next since the last release:

If you needed to make any changes doing the above QA (change PR titles, revert PRs), manually trigger a re-generation of this PR with this workflow and wait for it to finish.

@JReinhold JReinhold changed the title Build generate-pr-description script that generates a PR description for a Release PR Release Tooling Project: Build generate-pr-description script that generates a PR description for a Release PR May 17, 2023
@shilman
Copy link
Member

shilman commented May 24, 2023

Looks great!! 😍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants