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

feat: add "always-update" config option #2337

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

meyfa
Copy link
Contributor

@meyfa meyfa commented Jul 14, 2024

This patch adds a new option "always-update" that forces existing pull requests to be updated even when there are no changes to the release notes. This is useful, for example, when the repository enforces pull requests to be up-to-date with the main branch before they can be merged. Without this option set to true, that is, with the default behavior of release-please, if the last commit made to the main branch does not appear in the release notes, the existing pull request branch would not be rebased.


Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

Fixes #1459 🦕

Fixes googleapis#1459

This patch adds a new option "always-update" that forces existing pull
requests to be updated even when there are no changes to the
release notes. This is useful, for example, when the repository
enforces pull requests to be up-to-date with the main branch before
they can be merged. Without this option set to `true`, that is, with the
default behavior of release-please, if the last commit made to the
main branch does not appear in the release notes, the existing pull
request branch would not be rebased.
@meyfa meyfa requested review from a team as code owners July 14, 2024 13:02
@product-auto-label product-auto-label bot added the size: m Pull request size is medium. label Jul 14, 2024
Copy link
Contributor

@chingor13 chingor13 left a comment

Choose a reason for hiding this comment

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

Sorry for the delay in reviewing this.

Looks good, except we can make the always-update option only a top-level manifest configuration option (in the types).

@@ -174,6 +175,7 @@ interface ReleaserConfigJson {
'pull-request-header'?: string;
'pull-request-footer'?: string;
'separate-pull-requests'?: boolean;
'always-update'?: boolean;
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this one should be moved to ManifestConfig - ReleaserConfigJson are the per-component configurations and always-update seems to be a repository-wide configuration.

@zirkelc
Copy link
Contributor

zirkelc commented Oct 9, 2024

Hey @meyfa I'm really looking forward to this feature. Is there anything I can do to help, in case you're busy with other things at the moment?

@zirkelc zirkelc mentioned this pull request Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size: m Pull request size is medium.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update release PR on every change (instead of only changes that modify the changelog)
3 participants