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: allow onDemand configuration for release PRs #5073

Merged
merged 5 commits into from
Jun 1, 2023
Merged

Conversation

chingor13
Copy link
Contributor

@chingor13 chingor13 commented May 26, 2023

This feature allows a repo to configure onDemand: true which will only create the release PRs when you use the release-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:

manifest: true
onDemand: true
branches:
- branch: 1.x
  manifest: true
  onDemand: true

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.

@chingor13 chingor13 changed the title Rp on demand feat: allow onDemand configuration for release PRs May 26, 2023
@chingor13 chingor13 marked this pull request as ready for review May 26, 2023 18:01
@chingor13 chingor13 requested a review from a team as a code owner May 26, 2023 18:01
@dazuma
Copy link
Member

dazuma commented May 31, 2023

Yes please! (From the Ruby monorepo owner who broke owlbot yesterday due to quota issues stemming from multiple updates to hundreds of release PRs.)

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.

3 participants