Automate the backports on PR merge to main #27450

ahus1 · 2024-03-01T19:19:36Z

ahus1 · 2024-03-01T19:25:29Z

There is a recent run in my personal repository (only small changes afterwards): https://github.com/ahus1/keycloak/actions/runs/8116038073 (release 23 didn't exist, so it is expected to fail)

Here the backport branch reaper did its job: https://github.com/ahus1/keycloak/actions/runs/8115211801

When testing:

backport workflow needs to be in the main branch
backport reaper of old branches needs to be in the branches where the PRs are merged to (the release branches)

ahus1 · 2024-03-01T19:26:15Z

@ryanemerson - I'd be happy if you could review this when you have the time. I might run another test in my personal repo next week.

Thanks!

ahus1 · 2024-03-04T08:39:35Z

Completed my touch-ups and testing:

Works for a PR that has no backports / linked issues: https://github.com/ahus1/keycloak/actions/runs/8137152820
Works for a PR that has a backport: https://github.com/ahus1/keycloak/actions/runs/8137562459
Removes the backport branch in the main repo after the PR has been closed: https://github.com/ahus1/keycloak/actions/runs/8137571413

ryanemerson

Just an optional comment, otherwise LGTM 👍

ryanemerson · 2024-03-04T09:34:56Z

.github/workflows/backport.yaml

+        name: Check Backport
+        run: |
+          PR_NUMBER="${{ github.event.pull_request.number }}"
+          echo "PR:         https://github.com/$GITHUB_REPOSITORY/pull/$PR_NUMBER"


Instead of recreating the url, you can use: ${{ github.event.pull_request.html_url }}

Thanks, I've amended the PR!

ahus1 · 2024-03-04T09:59:45Z

@stianst - not sure who else to ask for this, so tagging you for a review when you have the time. Thanks!

stianst

Haven't had a chance to take a deep look, will try to do that tomorrow or Thursday, but couple things:

I'd suggest backport/22.0/<issue-num> for branch names if possible
Will need to add backport/** to branches-ignore for all workflows, as otherwise it will trigger two runs for a backport PR
I'm a bit worried about the reaper could end up deleting other branches if there's a mistake/error in it. Could we perhaps do something like gh api ... /repos/.../heads/backport/${{ ref }} so it couldn't delete for instance release/22 if something went wrong? Maybe branch protection could also work here, just want to make it somehow fault tolerant and not able to delete main and release branches

stianst · 2024-03-05T08:22:03Z

Wondering about an slightly alternative approach. We could have a backport workflow with workflow_dispatch then we could make the bot run the workflow either when a PR is merged with a linked issue with backport labels, or when a backport label is added to an issue that is already merged.

ahus1 · 2024-03-15T13:36:53Z

@stianst - I've updated the PR as you suggested. It is now a dispatch workflow.

An example PR created in my repositoy: ahus1#430

Once this is merged, people with write access to this repository can start using/testing it via the GitHub Workflow UI. Next step would updating the bot.

UPDATE: after the test, updated the naming pattern for the branch again, and added the missing branch ignores. I added them to all the places where dependabot is also ignored.

keycloak-github-bot

Unreported flaky test detected, please review

keycloak-github-bot · 2024-03-15T14:51:49Z

Unreported flaky test detected

If the flaky tests below are affected by the changes, please review and update the changes accordingly. Otherwise, a maintainer should report the flaky tests prior to merging the PR.

org.keycloak.testsuite.account.AccountRestServiceTest#updateConsentForClient

Keycloak CI - Java Distribution IT (windows-latest - temurin - 19)

java.lang.AssertionError
	at org.junit.Assert.fail(Assert.java:87)
	at org.junit.Assert.assertTrue(Assert.java:42)
	at org.junit.Assert.assertTrue(Assert.java:53)
	at org.keycloak.testsuite.account.AccountRestServiceTest.updateConsentForClient(AccountRestServiceTest.java:1344)
...

Report flaky test

Closes keycloak#27449 Signed-off-by: Alexander Schwartz <aschwart@redhat.com>

stianst · 2024-03-20T10:14:16Z

.github/workflows/backport-dispatch.yaml

+        type: string
+        default: "24.0"
+      pullRequest:
+        description: 'Pull request (just the ID)'


Should be number, PRs have both a number (28087) and an ID (PR_kwDOAKnDVc5qMnnG)

Suggested change

description: 'Pull request (just the ID)'

description: 'Pull request number'

jonkoops · 2024-03-20T10:38:23Z

.github/workflows/backport-dispatch.yaml

+        description: 'Release (22.0, 24.0, ...)'
+        required: true
+        type: string
+        default: "24.0"


Should we have a default at all? This is likely to get quickly out of date. Also, can we provide a default if this value is already required?

jonkoops · 2024-03-20T10:48:39Z

.github/workflows/backport-dispatch.yaml

+    runs-on: ubuntu-latest
+    steps:
+      - name: Backporting
+        uses: kiegroup/git-backporting@bce5dd4f9969d47da9cbb6ed06abbf87216afc98 # 4.5.1


For consistency, should we not be using the existing backport script here directly? If we're going to use an action going forward I'd argue it should be the only way to do a backport to avoid inconsistencies.

Personally I would just use the script and not an action, as I find it easy and quick to do that, but if others prefer a action then I don't see a big deal with having both. Good point about using the same approach both places thouyy

.github/workflows/backport-reaper.yaml

.github/workflows/ci.yml

ahus1 force-pushed the is-27449-automate-backport branch from 5e75b83 to 6189842 Compare March 1, 2024 19:22

ahus1 requested a review from ryanemerson March 1, 2024 19:25

ahus1 self-assigned this Mar 1, 2024

keycloak-github-bot bot added the flaky-test label Mar 1, 2024

keycloak-github-bot bot mentioned this pull request Mar 1, 2024

Flaky test: org.keycloak.testsuite.ui.account2.UpdateEmailTest#updateUserInfoWithRegistrationEnabled #24367

Closed

ahus1 force-pushed the is-27449-automate-backport branch from 6189842 to 2394d04 Compare March 4, 2024 08:37

ahus1 marked this pull request as ready for review March 4, 2024 08:39

ahus1 requested a review from a team as a code owner March 4, 2024 08:39

ryanemerson approved these changes Mar 4, 2024

View reviewed changes

keycloak-github-bot bot mentioned this pull request Mar 4, 2024

Flaky test: org.keycloak.testsuite.ui.account2.SessionTest#welcomeScreenSsoTimeoutTest #24409

Closed

ahus1 force-pushed the is-27449-automate-backport branch from 2394d04 to a459f9c Compare March 4, 2024 09:56

ahus1 requested a review from stianst March 4, 2024 09:58

stianst reviewed Mar 5, 2024

View reviewed changes

ahus1 force-pushed the is-27449-automate-backport branch from a459f9c to 945aae6 Compare March 15, 2024 13:35

ahus1 force-pushed the is-27449-automate-backport branch 2 times, most recently from 49ead3e to ef9d429 Compare March 15, 2024 13:40

ahus1 requested a review from stianst March 15, 2024 14:11

keycloak-github-bot bot mentioned this pull request Mar 15, 2024

Flaky test: org.keycloak.testsuite.forms.ResetPasswordTest#resetPasswordLink #21422

Closed

keycloak-github-bot bot reviewed Mar 15, 2024

View reviewed changes

Automate backports via a dispatch workflow

4db6ce6

Closes keycloak#27449 Signed-off-by: Alexander Schwartz <aschwart@redhat.com>

ahus1 force-pushed the is-27449-automate-backport branch from ef9d429 to 4db6ce6 Compare March 18, 2024 07:54

keycloak-github-bot bot mentioned this pull request Mar 18, 2024

Flaky test: org.keycloak.testsuite.oauth.OfflineTokenTest#offlineTokenBrowserFlowIdleTimeExpired #22845

Open

stianst reviewed Mar 20, 2024

View reviewed changes

jonkoops reviewed Mar 20, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Automate the backports on PR merge to main #27450

Automate the backports on PR merge to main #27450

ahus1 commented Mar 1, 2024

ahus1 commented Mar 1, 2024

ahus1 commented Mar 1, 2024

ahus1 commented Mar 4, 2024

ryanemerson left a comment

ryanemerson Mar 4, 2024

ahus1 Mar 4, 2024

ahus1 commented Mar 4, 2024

stianst left a comment

stianst commented Mar 5, 2024

ahus1 commented Mar 15, 2024 •

edited

keycloak-github-bot bot left a comment

keycloak-github-bot bot commented Mar 15, 2024

stianst Mar 20, 2024

jonkoops Mar 20, 2024

jonkoops Mar 20, 2024

stianst Mar 21, 2024

	description: 'Pull request (just the ID)'
	description: 'Pull request number'

Automate the backports on PR merge to main #27450

Are you sure you want to change the base?

Automate the backports on PR merge to main #27450

Conversation

ahus1 commented Mar 1, 2024

ahus1 commented Mar 1, 2024

ahus1 commented Mar 1, 2024

ahus1 commented Mar 4, 2024

ryanemerson left a comment

Choose a reason for hiding this comment

ryanemerson Mar 4, 2024

Choose a reason for hiding this comment

ahus1 Mar 4, 2024

Choose a reason for hiding this comment

ahus1 commented Mar 4, 2024

stianst left a comment

Choose a reason for hiding this comment

stianst commented Mar 5, 2024

ahus1 commented Mar 15, 2024 • edited

keycloak-github-bot bot left a comment

Choose a reason for hiding this comment

keycloak-github-bot bot commented Mar 15, 2024

Unreported flaky test detected

org.keycloak.testsuite.account.AccountRestServiceTest#updateConsentForClient

stianst Mar 20, 2024

Choose a reason for hiding this comment

jonkoops Mar 20, 2024

Choose a reason for hiding this comment

jonkoops Mar 20, 2024

Choose a reason for hiding this comment

stianst Mar 21, 2024

Choose a reason for hiding this comment

ahus1 commented Mar 15, 2024 •

edited