feat: allow onDemand configuration for release PRs #5073
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This feature allows a repo to configure
onDemand: true
which will only create the release PRs when you use therelease-please:force-run
label. It will tag the releases on pushes to the release branch (e.g.main
).This is useful for monorepos that choose when they want to run releases (i.e. they do not always want a release PR as soon as a feature is merged). Additionally, it should reduce the sheer number of API calls the app makes for monorepos that have a set release schedule.
To configure, you can add
onDemand: true
to your.github/release-please.yml
. Example:Note: this option makes it so that your release PR could be "out of date" with the latest code in the release branch, so maintainers will need to pay close attention.