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.

Sign up for GitHub

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

Jump to bottom

Auto-merge Backport PRs in documentation-website repo #6400

Closed
Naarcha-AWS opened this issue Feb 9, 2024 · 13 comments
Closed

Auto-merge Backport PRs in documentation-website repo #6400

Naarcha-AWS opened this issue Feb 9, 2024 · 13 comments
Assignees
@peterzhuamazon @Naarcha-AWS
Labels
2 - In progress Issue/PR: The issue or PR is in progress. enhancement New feature or request

Comments

@Naarcha-AWS
Copy link
Collaborator

Naarcha-AWS commented Feb 9, 2024 •
edited by peterzhuamazon
Loading

Is your feature request related to a problem? Please describe

The Backport tool, while efficient, can occasionally cause friction when a maintainer forgets to merge a PR. Furthermore, the documentation-website repo currently requires that all PRs be "approved", including Backports, which means that maintainers need to take an extra-step to merge a Backport PR even when that PR has passed all checks.

Describe the solution you'd like

  • Remove the requirement for Backport PRs to require approvals, if possible.
  • If a Backport PR passes all pipeline and implementations tests, automatically merge that PR upon approval.

Describe alternatives you've considered

We've considered turning on the auto-merge feature for all PRs. However, the quality-control process for documentation PRs prevents us from auto-merging PRs to the main branch, since all PRs must not only pass code-review, but also editorial review. This means that, even though a PR may technically pass GitHub's and organizations requirements for merging, it might not pass the documentation teams quality requirements.

Additional context

For additional information, see #6305

More changes on other repos for the similar implementation:
@Naarcha-AWS Naarcha-AWS added enhancement New feature or request untriaged labels Feb 9, 2024
@Naarcha-AWS Naarcha-AWS changed the title Automerge Backport PRs in documentation-website repo Auto-merge Backport PRs in documentation-website repo Feb 9, 2024
@rishabh6788
Copy link

Transferring to documentation repo.

@rishabh6788 rishabh6788 transferred this issue from opensearch-project/opensearch-build Feb 13, 2024
@bbarani
Copy link
Member

bbarani commented Feb 14, 2024 •
edited
Loading

@rishabh6788 will discuss with @Naarcha-AWS to understand the requirements. CC: @hdhalter

@hdhalter hdhalter added the 1 - Backlog - DOC Doc writer assigned to issue responsible for creating PR. label Feb 17, 2024
@peterzhuamazon peterzhuamazon self-assigned this Mar 28, 2024
@peterzhuamazon peterzhuamazon moved this from Backlog to In Progress in OpenSearch Engineering Effectiveness Mar 28, 2024
@peterzhuamazon
Copy link
Member

Have discussion with @Naarcha-AWS offline and will take a look with auto approval before auto merging.

Thanks.

@peterzhuamazon
Copy link
Member

Added backport remove rule so they can properly remove the branches now.

Screenshot 2024-03-28 at 4 43 21 PM

@peterzhuamazon
Copy link
Member

peterzhuamazon commented Mar 28, 2024 •
edited
Loading

Will remove these:


  origin/backport/backport-1825-to-1.3
  origin/backport/backport-1834-to-1.3
  origin/backport/backport-2143-to-1.3
  origin/backport/backport-2171-to-1.3
  origin/backport/backport-2342-to-1.3
  origin/backport/backport-2354-to-1.3
  origin/backport/backport-2355-to-1.3
  origin/backport/backport-2360-to-2.4
  origin/backport/backport-2371-to-1.3
  origin/backport/backport-2377-to-1.3
  origin/backport/backport-2385-to-1.3
  origin/backport/backport-2409-to-2.4
  origin/backport/backport-2427-to-1.3
  origin/backport/backport-2449-to-2.3
  origin/backport/backport-2454-to-1.3
  origin/backport/backport-2457-to-1.3
  origin/backport/backport-2458-to-1.3
  origin/backport/backport-2492-to-1.3
  origin/backport/backport-2513-to-1.3
  origin/backport/backport-2518-to-1.3
  origin/backport/backport-2544-to-1.3
  origin/backport/backport-2555-to-1.3
  origin/backport/backport-2557-to-1.3
  origin/backport/backport-2564-to-1.3
  origin/backport/backport-2571-to-1.3
  origin/backport/backport-2599-to-1.3
  origin/backport/backport-2630-to-1.3
  origin/backport/backport-2640-to-1.3
  origin/backport/backport-2641-to-1.3
  origin/backport/backport-2653-to-1.3
  origin/backport/backport-2658-to-1.3
  origin/backport/backport-2668-to-1.3
  origin/backport/backport-2730-to-2.6
  origin/backport/backport-2750-to-1.3
  origin/backport/backport-2762-to-2.4
  origin/backport/backport-2824-to-1.3
  origin/backport/backport-2828-to-1.3
  origin/backport/backport-2829-to-1.3
  origin/backport/backport-2880-to-2.4
  origin/backport/backport-2885-to-2.4
  origin/backport/backport-2885-to-2.5
  origin/backport/backport-2927-to-1.3
  origin/backport/backport-2941-to-1.3
  origin/backport/backport-2946-to-1.3
  origin/backport/backport-2946-to-2.4
  origin/backport/backport-2962-to-1.3
  origin/backport/backport-2999-to-1.3
  origin/backport/backport-3004-to-1.3
  origin/backport/backport-3007-to-1.3
  origin/backport/backport-3025-to-2.4
  origin/backport/backport-3035-to-1.3
  origin/backport/backport-3052-to-1.3
  origin/backport/backport-3054-to-1.3
  origin/backport/backport-3069-to-1.3
  origin/backport/backport-3085-to-1.3
  origin/backport/backport-3086-to-1.3
  origin/backport/backport-3097-to-1.3
  origin/backport/backport-3106-to-1.3
  origin/backport/backport-3119-to-1.3
  origin/backport/backport-3127-to-1.3
  origin/backport/backport-3144-to-1.3
  origin/backport/backport-3146-to-1.3
  origin/backport/backport-3170-to-1.3
  origin/backport/backport-3200-to-1.3
  origin/backport/backport-3230-to-1.3
  origin/backport/backport-3250-to-1.3
  origin/backport/backport-3252-to-1.3
  origin/backport/backport-3253-to-1.3
  origin/backport/backport-3350-to-1.3
  origin/backport/backport-3380-to-1.3
  origin/backport/backport-3426-to-1.3
  origin/backport/backport-3428-to-1.3
  origin/backport/backport-3433-to-1.3
  origin/backport/backport-3467-to-1.3
  origin/backport/backport-3547-to-2.6
  origin/backport/backport-3550-to-2.6
  origin/backport/backport-3584-to-1.3
  origin/backport/backport-3615-to-1.3
  origin/backport/backport-3637-to-1.3
  origin/backport/backport-3645-to-1.3
  origin/backport/backport-3709-to-1.0
  origin/backport/backport-3709-to-1.1
  origin/backport/backport-3709-to-1.2
  origin/backport/backport-3709-to-1.3
  origin/backport/backport-3759-to-1.3
  origin/backport/backport-3775-to-1.3
  origin/backport/backport-3785-to-1.3
  origin/backport/backport-3789-to-1.3
  origin/backport/backport-3812-to-1.3
  origin/backport/backport-3964-to-1.3
  origin/backport/backport-3995-to-1.3
  origin/backport/backport-4029-to-2.7
  origin/backport/backport-4038-to-2.4
  origin/backport/backport-4044-to-1.3
  origin/backport/backport-4101-to-1.3
  origin/backport/backport-4106-to-1.3
  origin/backport/backport-4126-to-1.3
  origin/backport/backport-4149-to-1.3
  origin/backport/backport-4161-to-2.7
  origin/backport/backport-4218-to-1.3
  origin/backport/backport-4218-to-2.7
  origin/backport/backport-4224-to-2.8
  origin/backport/backport-4241-to-1.3
  origin/backport/backport-4268-to-1.3
  origin/backport/backport-4302-to-1.0
  origin/backport/backport-4302-to-1.1
  origin/backport/backport-4302-to-1.2
  origin/backport/backport-4302-to-1.3
  origin/backport/backport-4310-to-2.7
  origin/backport/backport-4313-to-1.3
  origin/backport/backport-4348-to-1.3
  origin/backport/backport-4349-to-2.8
  origin/backport/backport-4352-to-1.3
  origin/backport/backport-4363-to-1.3
  origin/backport/backport-4390-to-1.3
  origin/backport/backport-4392-to-1.3
  origin/backport/backport-4424-to-1.3
  origin/backport/backport-4434-to-1.3
  origin/backport/backport-4436-to-1.3
  origin/backport/backport-4463-to-2.5
  origin/backport/backport-4512-to-1.3
  origin/backport/backport-4530-to-1.3
  origin/backport/backport-4543-to-2.8
  origin/backport/backport-4558-to-1.3
  origin/backport/backport-4560-to-1.3
  origin/backport/backport-4591-to-1.3
  origin/backport/backport-4619-to-1.3
  origin/backport/backport-4655-to-1.3
  origin/backport/backport-4656-to-1.3
  origin/backport/backport-4664-to-1.3
  origin/backport/backport-4665-to-1.3
  origin/backport/backport-4693-to-1.3
  origin/backport/backport-4740-to-1.3
  origin/backport/backport-4768-to-1.3
  origin/backport/backport-4772-to-1.3
  origin/backport/backport-4787-to-1.3
  origin/backport/backport-4789-to-1.3
  origin/backport/backport-4790-to-1.3
  origin/backport/backport-4821-to-1.3
  origin/backport/backport-4822-to-1.3
  origin/backport/backport-4836-to-1.3
  origin/backport/backport-4851-to-1.3
  origin/backport/backport-4856-to-1.3
  origin/backport/backport-4880-to-1.3
  origin/backport/backport-4892-to-1.3
  origin/backport/backport-4921-to-1.3
  origin/backport/backport-4970-to-1.3
  origin/backport/backport-5019-to-2.1
  origin/backport/backport-5019-to-2.2
  origin/backport/backport-5019-to-2.3
  origin/backport/backport-5063-to-1.3
  origin/backport/backport-5084-to-1.3
  origin/backport/backport-5208-to-1.3
  origin/backport/backport-5242-to-1.3
  origin/backport/backport-5272-to-1.3
  origin/backport/backport-5299-to-1.3
  origin/backport/backport-5320-to-1.3
  origin/backport/backport-5340-to-1.3
  origin/backport/backport-5378-to-2.8
  origin/backport/backport-5432-to-1.3
  origin/backport/backport-5458-to-1.3
  origin/backport/backport-5580-to-1.3
  origin/backport/backport-5619-to-1.3
  origin/backport/backport-5619-to-2.9
  origin/backport/backport-5628-to-2.9
  origin/backport/backport-5667-to-2.10
  origin/backport/backport-5667-to-2.11
  origin/backport/backport-5667-to-2.9
  origin/backport/backport-5669-to-1.3
  origin/backport/backport-5669-to-2.0
  origin/backport/backport-5669-to-2.1
  origin/backport/backport-5669-to-2.10
  origin/backport/backport-5669-to-2.11
  origin/backport/backport-5669-to-2.2
  origin/backport/backport-5669-to-2.3
  origin/backport/backport-5669-to-2.4
  origin/backport/backport-5669-to-2.5
  origin/backport/backport-5669-to-2.6
  origin/backport/backport-5669-to-2.7
  origin/backport/backport-5669-to-2.8
  origin/backport/backport-5669-to-2.9
  origin/backport/backport-5724-to-2.11
  origin/backport/backport-5725-to-1.3
  origin/backport/backport-5768-to-1.3
  origin/backport/backport-5824-to-1.3
  origin/backport/backport-5827-to-1.3
  origin/backport/backport-5844-to-1.3
  origin/backport/backport-5924-to-1.3
  origin/backport/backport-5969-to-2.10
  origin/backport/backport-5969-to-2.7
  origin/backport/backport-5969-to-2.8
  origin/backport/backport-5969-to-2.9
  origin/backport/backport-5978-to-1.3
  origin/backport/backport-6048-to-1.3
  origin/backport/backport-6069-to-1.3
  origin/backport/backport-6108-to-1.3
  origin/backport/backport-6137-to-1.3
  origin/backport/backport-6151-to-1.3
  origin/backport/backport-6194-to-1.3
  origin/backport/backport-6208-to-1.3
  origin/backport/backport-6307-to-1.3
  origin/backport/backport-6380-to-2.12
  origin/backport/backport-6427-to-1.3
  origin/backport/backport-6452-to-1.3
  origin/backport/backport-6470-to-1.3
  origin/backport/backport-6582-to-1.3
  origin/backport/backport-6717-to-2.7

@peterzhuamazon
Copy link
Member

The github settings of automerge is more on specific PR not on all PRs matching a condition:
https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request#enabling-auto-merge

@peterzhuamazon
Copy link
Member

peterzhuamazon commented Mar 28, 2024 •
edited
Loading

Still prefer flow:
Add backport label -> Backport PR created -> Backport PR add backport-automerge label to identify -> assume trigger bot token -> Approve by trigger bot -> Wait for status check to complete -> Automerge -> Remove backport branch.

PRs:

  • update

@peterzhuamazon peterzhuamazon mentioned this issue Mar 28, 2024
Merged
1 task
@hdhalter
Copy link
Contributor

Still prefer flow: Add backport label -> Backport PR created -> assume trigger bot token -> Approve by trigger bot -> Wait for status check to complete -> Automerge -> Remove backport branch.

We'd also like to receive some kind of notification if there is a merge conflict on the backport PR.

@Naarcha-AWS Naarcha-AWS added 2 - In progress Issue/PR: The issue or PR is in progress. and removed 1 - Backlog - DOC Doc writer assigned to issue responsible for creating PR. labels Mar 28, 2024
@Naarcha-AWS
Copy link
Collaborator Author

Still prefer flow: Add backport label -> Backport PR created -> assume trigger bot token -> Approve by trigger bot -> Wait for status check to complete -> Automerge -> Remove backport branch.

We'd also like to receive some kind of notification if there is a merge conflict on the backport PR.

That notification will appear if the status checks don't complete, I believe.

@peterzhuamazon peterzhuamazon mentioned this issue Mar 29, 2024
Merged
1 task
@peterzhuamazon
Copy link
Member

Will need to tweak the backport workflow source code to add a label, or find the PR number and use gh to add a label through workflow files.

https://github.com/VachaShah/backport

This was referenced Apr 2, 2024
Merged
Merged
Merged
@peterzhuamazon
Copy link
Member

peterzhuamazon commented Apr 4, 2024 •
edited
Loading

New flow PR:

@peterzhuamazon
Copy link
Member

New backport automerge:

This was referenced Apr 5, 2024
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Open
Open
@peterzhuamazon
Copy link
Member

This is completed now for docs team.
All the other repos changes will be in META:

Thanks.

@peterzhuamazon peterzhuamazon mentioned this issue Dec 4, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@peterzhuamazon peterzhuamazon

@Naarcha-AWS Naarcha-AWS

Labels
2 - In progress Issue/PR: The issue or PR is in progress. enhancement New feature or request
Projects
OpenSearch Engineering Effectiveness
Status: Done
Milestone
No milestone
Development

No branches or pull requests
5 participants
@rishabh6788 @peterzhuamazon @bbarani @Naarcha-AWS @hdhalter