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

docs: suggest to let Renovate bypass mandatory Pull Request reviews #16370

Merged
merged 4 commits into from
Jul 2, 2022

Conversation

Shegox
Copy link
Contributor

@Shegox Shegox commented Jul 1, 2022

Changes

This PR recommends that users should add Renovate to the list of users, which are allowed to bypass mandatory Pull Request instead of installing the auto-approve App.
This has the advantage that no additional App is required. In the long term, renovate-approve could be deprecated in favor of this approach overall.

Context

GitHub added this new feature in November 2021 and I couldn't find it yet in the Renovate docs.

Fixes #15659

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please tick one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

Merging without approval: tobias-something-something/automerge-test#3
image
although required PRs are configured
image

@Shegox Shegox changed the title chore(docs): Suggest to let Renovate bypass mandatory Pull Request chore(docs): Suggest to let Renovate bypass mandatory Pull Request reviews Jul 1, 2022
@HonkingGoose
Copy link
Collaborator

GitHub added this new feature in November 2021 and I couldn't find it yet in the Renovate docs.

You're totally right! 😉 I created an issue to figure out how to describe the branch protection exception for Renovate in our docs:

The problem is that we should probably change more than just add a single line somewhere in the docs. And also, if we tell our users to add Renovate bot as an exception, it should work for automerge=pr and automerge=branch.

@HonkingGoose HonkingGoose requested a review from rarkins July 1, 2022 16:42
@Shegox
Copy link
Contributor Author

Shegox commented Jul 1, 2022

GitHub added this new feature in November 2021 and I couldn't find it yet in the Renovate docs.

You're totally right! 😉 I created an issue to figure out how to describe the branch protection exception for Renovate in our docs:

The problem is that we should probably change more than just add a single line somewhere in the docs. And also, if we tell our users to add Renovate bot as an exception, it should work for automerge=pr and automerge=branch.

I searched if there was an issue already open for this, but missed that one. 😅

In my test, a PR merge worked. Let me further explore this next week and better document it.

@Shegox Shegox marked this pull request as draft July 1, 2022 16:47
@Shegox
Copy link
Contributor Author

Shegox commented Jul 1, 2022

And testing using autoMergeType: branch via tobias-something-something/automerge-test@b5df255, works as well as expected.

So overall it seems to work for all my tested cases: branch and PR and even works, if "Require review from Code Owners" is enabled:
image

@Shegox Shegox marked this pull request as ready for review July 1, 2022 19:17
@Shegox Shegox changed the title chore(docs): Suggest to let Renovate bypass mandatory Pull Request reviews chore(docs): suggest to let Renovate bypass mandatory Pull Request reviews Jul 1, 2022
rarkins
rarkins previously approved these changes Jul 2, 2022
Copy link
Collaborator

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

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

Small style change.

docs/usage/key-concepts/automerge.md Outdated Show resolved Hide resolved
@rarkins rarkins changed the title chore(docs): suggest to let Renovate bypass mandatory Pull Request reviews docs: suggest to let Renovate bypass mandatory Pull Request reviews Jul 2, 2022
@rarkins rarkins enabled auto-merge (squash) July 2, 2022 07:26
@rarkins rarkins merged commit c7c163e into renovatebot:main Jul 2, 2022
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 32.103.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 2, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Renovate bot can be excepted from branch protection rules on GitHub
4 participants