Replace mergify with GHAs #3346

micsza · 2023-11-28T10:47:05Z

Replacing mergify that gets hard to maintain with GitHub actions with features:

automerge for PRs

automerge label is attached if and only if the PR author is softwaremill-ci and exactly one file from the specified list is changed,
auto-merge action is performed if and only if there is an automerge label attached and ci and mima jobs complete successfully.

/rebase as PR comment to rebase it.

amorfis · 2023-11-28T11:46:08Z

.github/workflows/ci.yml

+               echo "changed_files_num=$N" >> $GITHUB_OUTPUT
+      - name: Launch labeler
+        # skip if more than one file changed
+        if: steps.count-changed-files.outputs.changed_files_num == 1


Is it always the same file changing? If so, we should check also if this is the one that has changed. We don't want the job to run if it is other file changed do we?

I can't see a scenario in which this "modified file swap" thing could happen - would you pls give an example?

Apparently I don't understand something. Doesn't it happen when I modify 1 file - and it's some other file than expected?

There is white list of three files that we consider valid for "automerge" in file labeler.yml. So if steward modifies <> 1 file nothing happens, if it modifies exactly 1 one, then that file will be checked against that white list - if it is on it, then automerge label will attached, otherwise no label.

let's add all this in comments - somebody reading the build file will have no idea to look into labeler.yml :)

amorfis · 2023-11-28T11:47:00Z

.github/workflows/ci.yml

@@ -103,8 +106,12 @@ jobs:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

  mima:


What is this job for?

Ensures that changes in the core module don't break binary compatibility.

let's add a comment, if it's not clear :)

adamw · 2023-11-28T14:55:48Z

.github/workflows/ci.yml

@@ -175,3 +182,38 @@ jobs:
          version: "v${{ env.VERSION }}"
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  label:
+    name: Attach automerge label


can we attach the dependency label? it's later used when creating the release notes

Added, some DRY was needed though.

though now the comment needs updating, as we attach two labels :)

or maybe we can just say this step attaches the labels specified in labelers.yml, but only if the PR changes one file

adamw · 2023-11-28T14:57:54Z

.github/workflows/rebase-cmd.yml

+name: rebase-command
+on:
+  repository_dispatch:
+    types: [rebase-command]


how are these two wired together? somme comments on how this works and what are the roles of the two workflows would be great :)

Any comment triggers Slash Comment Dispatch which checks if there is /rebase in the comment body, if yes then it dispatches a rebase command with event type rebase-command which triggers rebase-command workflow that performs the rebase operation. Will add comments.

Comments added.

adamw · 2023-11-28T14:58:58Z

.github/workflows/rebase-cmd-dispatch.yml

+name: Slash Command Dispatch
+on:
+  issue_comment:
+    types: [created]


can we only run this action if the text == /rebase? otherwise we'll get a lot of actions which do nothing

AFAIK, there is no way to trigger workflow based on the content of the issue comment. Eventually we could add a condition for job like if: contains(github.event.comment.body, '/rebase') so that it will be fast-skipped but still the Action space will be polluted with tons of skipped actions triggered, each one triggered by a single comment.

I guess fast-skip is better than nothing, let's try and we'll se if it works fine for us

adamw · 2023-11-29T08:28:55Z

.github/workflows/ci.yml

+    name: Auto merge
+    # only for PRs by softwaremill-ci
+    if: github.event.pull_request.user.login == 'softwaremill-ci'
+    needs: [ ci, mima, label ]


does a needs=label require that the label was successfully applied?

Not exactly - it requires to wait for label job to complete. The required label (automerge) will be checked anyway inside the action, the needs=label was added just to conform with job dependencies relation - first label, then automerge - and it protects from the (well nearly impossible) scenario when auto-merge job starts when the label job has not yet completed.

ah ok:) yeah I guess I'm missing some info on what's the flow and when various files are used

adamw · 2023-11-30T07:23:06Z

.github/workflows/rebase-cmd-dispatch.yml

@@ -0,0 +1,19 @@
+# On any comment, it will look for '/rebase' in the comment body and in case of hit, it dispatches rebase cmd
+# with event type 'rebase-command' which triggers 'rebase-command` WF that performs the rebase operation.


this doesn't explain the relation between rebase-cmd-dispatch and rebase-cmd, I still don't understand what it is

adamw

A couple more comments on comments :) Let's merge & see how this works after that - we can test by /rebase-ing a couple of waiting dependency PRs

micsza force-pushed the replace-mergify-with-ghas branch 2 times, most recently from 3a60a99 to 35bf733 Compare November 28, 2023 10:51

amorfis reviewed Nov 28, 2023

View reviewed changes

kciesielski approved these changes Nov 28, 2023

View reviewed changes

adamw reviewed Nov 28, 2023

View reviewed changes

micsza added 4 commits November 29, 2023 08:21

Add labeler and automerge.

60d2c1f

Remove .mergify.yml

c176e1b

Add rebase cmd via PR comment.

796b7d2

Bring back branches on push.

a068965

adamw reviewed Nov 29, 2023

View reviewed changes

micsza added 2 commits November 29, 2023 13:53

dependency label

471f104

comments added

d677f91

micsza force-pushed the replace-mergify-with-ghas branch from 35bf733 to d677f91 Compare November 29, 2023 14:45

fast skip for non-rebase comments

cddafbf

adamw reviewed Nov 30, 2023

View reviewed changes

adamw approved these changes Nov 30, 2023

View reviewed changes

micsza merged commit 3cfec95 into master Nov 30, 2023
29 checks passed

Pask423 deleted the replace-mergify-with-ghas branch May 7, 2024 07:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace mergify with GHAs #3346

Replace mergify with GHAs #3346

micsza commented Nov 28, 2023 •

edited

Loading

amorfis Nov 28, 2023 •

edited

Loading

micsza Nov 28, 2023

amorfis Nov 28, 2023

micsza Nov 29, 2023

adamw Nov 29, 2023

micsza Nov 29, 2023

amorfis Nov 28, 2023 •

edited

Loading

kciesielski Nov 28, 2023

adamw Nov 28, 2023

micsza Nov 29, 2023

adamw Nov 28, 2023

micsza Nov 29, 2023

adamw Nov 30, 2023

adamw Nov 30, 2023

adamw Nov 28, 2023

micsza Nov 29, 2023

micsza Nov 29, 2023

adamw Nov 28, 2023

micsza Nov 29, 2023

adamw Nov 29, 2023

micsza Nov 29, 2023

adamw Nov 29, 2023

micsza Nov 29, 2023

adamw Nov 29, 2023

adamw Nov 30, 2023

adamw Nov 30, 2023

adamw left a comment

		@@ -103,8 +106,12 @@ jobs:
		GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

		mima:

		@@ -0,0 +1,19 @@
		# On any comment, it will look for '/rebase' in the comment body and in case of hit, it dispatches rebase cmd
		# with event type 'rebase-command' which triggers 'rebase-command` WF that performs the rebase operation.

Replace mergify with GHAs #3346

Replace mergify with GHAs #3346

Conversation

micsza commented Nov 28, 2023 • edited Loading

amorfis Nov 28, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

amorfis Nov 28, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adamw left a comment

Choose a reason for hiding this comment

micsza commented Nov 28, 2023 •

edited

Loading

amorfis Nov 28, 2023 •

edited

Loading

amorfis Nov 28, 2023 •

edited

Loading