Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Use Pull Request grouping to reduce PR noise #40

Merged
merged 1 commit into from
May 24, 2023
Merged

Conversation

rtyley
Copy link
Member

@rtyley rtyley commented May 24, 2023

In October 2022 scala-steward-org/scala-steward#2714 introduced the capability to group together pull requests with pullRequests.grouping. If you want, you can have all updates go into one single PR, or you can also group by criteria, so that noisy releasers (like AWS SDK) are grouped into one PR, while everything else goes into another PR (these might be more significant updates that people would want to consider more urgently). This dramatically reduces update noise!

Instead of getting multiple individual PRs called things like:

  • Update aws-java-sdk-ssm to 1.12.341
  • Update aws-lambda-java-core to 1.2.2
  • Update threeten-extra to 1.7.2
  • ...

...Scala Steward will now only ever open 2 PRs:

  • AWS dependency updates (example PR) - which you can usually treat as non-urgent
  • Non-AWS dependency updates (example PR) - changes which are more likely to be significant

I've been using it on guardian/play-secret-rotation and I'd say it behaves well (see some example resulting PRs: non-AWS & AWS):

image

Department consensus

This department-wide config change was discussed at the P&E Server-side meetup on 1st February 2023, to positive assent - I just never got around to making the PR until now!

In October 2022 scala-steward-org/scala-steward#2714 introduced the capability to group together
pull requests. If you want, you can have all updates go into one single PR, or you can also group by criteria, so that noisy releasers (like AWS SDK) are grouped into one PR, while everything else goes into another PR (these might be more significant updates that people would want to consider more urgently).

The behaviour (I _think_) appears to be that once a grouped PR is created, it's _not_ updated with new updates, so you have to merge it before you get another round of updates - but I don't think that's so bad. It certainly dramatically reduces update noise.

I've been using it on https://github.com/guardian/play-secret-rotation and I'd say it behaves well.

This department-wide config change was discussed at the P&E Server-side meetup on 1st February 2023, to positive assent (I just never got around to making the PR until now!).

https://docs.google.com/document/d/1wtZPwICuEeMQ8Ga7ErUIMZsWalnsI0DpnvnkNI3Qy5U/edit#heading=h.vjxmdl6a7ue3

https://github.com/scala-steward-org/scala-steward/blob/dc85945c95c69cb8dce3d4b5f862e41ecd692417/docs/repo-specific-configuration.md?plain=1#L37-L72
@rtyley rtyley requested a review from NovemberTang May 24, 2023 09:50
@rtyley rtyley merged commit dc1a300 into main May 24, 2023
@rtyley rtyley deleted the pull-request-grouping branch May 24, 2023 10:09
rtyley added a commit to guardian/google-search-indexing-observatory that referenced this pull request May 26, 2023
@rtyley
Copy link
Member Author

rtyley commented Jun 22, 2023

As a clean-up operation for this, I've manually closed the ~420 legacy ungrouped PRs that Scala Steward had previously opened before this change meant that Scala Steward would group its PRs. The old PRs were no longer being maintained by Scala Steward, so it makes sense to close them!

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants