Add GHA workflows to auto-merge dependency updates and bundle GB dependency updates per GB plugin release #6302

pierlon · 2021-05-21T04:07:26Z

Summary

Fixes #6298

Adds GHA workflows to:

Auto-merge PRs from Dependabot that are approvelisted
Check for Gutenberg plugin updates and if there is a new one create a PR with the set of Gutenberg related dependency updates

Checklist

My code is tested and passes existing tests.
My code follows the Engineering Guidelines (updates are often made to the guidelines, check it out periodically).

pierlon · 2021-05-21T04:13:14Z

.github/workflows/auto-merge.yml

+        if: >
+          # Auto merge `@wordpress/` dependency PRs
+          startsWith( ${{ github.event.pull_request.title }}, 'Bump @wordpress' )


We can update this if condition as a means to whitelist auto-merging for other dependency updates.

At the moment this won't do anything because the @wordpress dependencies are excluded, right?

Yep, they're ignored in the Dependabot config.

github-actions · 2021-05-21T05:09:48Z

Plugin builds for aadb449 are ready 🛎️!

Download development build
Download production build

…n update is released

pierlon · 2021-05-22T03:25:51Z

In 4e54f17 I added a new GHA workflow that monitors the Gutenberg repo for plugin releases, and if there is one it opens a PR containing the related dependency updates since that release.

.github/workflows/gutenberg-packages-update.yml

westonruter · 2021-05-24T19:17:46Z

.github/workflows/gutenberg-packages-update.yml

+          echo "::set-output name=version::$(echo "$LAST_VERSION")"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          QUERY: 'repo:ampproject/amp-wp is:pr is:open is:merged in:title Update Gutenberg packages after'


Should this do an author check as well to be safe?

Done in 46b6ef7.

westonruter · 2021-05-24T19:23:01Z

.github/workflows/gutenberg-packages-update.yml

+        id: last-release
+        run: |
+          PR_TITLE=$(gh api -X GET search/issues -f q='${{ env.QUERY }}' -f sort='created' -f order='desc' --jq '.items.[].title' | head -n 1)
+          LAST_VERSION=$(node -e "'$PR_TITLE' && console.log( '$PR_TITLE'.match('v(.+) release')[1] )")


What's the '$PR_TITLE' && part for?

If the matched pull request contains any quotation marks (perhaps by malicious user), then this will cause an error.

Perhaps something like this would be better:

Suggested change

LAST_VERSION=$(node -e "'$PR_TITLE' && console.log( '$PR_TITLE'.match('v(.+) release')[1] )")

LAST_VERSION=$(sed 's/.* $v.*$.*/$1/' <<< "$PR_TITLE")

This could then also do a check to see if it the resulting LAST_VERSION matches ^v\d+(\.\d+)*$

Done in f0a0dab.

westonruter · 2021-05-24T19:24:46Z

.github/workflows/gutenberg-packages-update.yml

+
+      - name: Determine if with package updates are needed
+        id: release-status
+        run: echo "::set-output name=outdated::$(php -r "echo json_encode(version_compare('$LATEST_VER', '$LAST_VER', '>'));")"


Suggested change

run: echo "::set-output name=outdated::$(php -r "echo json_encode(version_compare('$LATEST_VER', '$LAST_VER', '>'));")"

run: echo "::set-output name=outdated::$(php -r "echo json_encode(version_compare($argv[1], $argv[2], '>'));" "$LATEST_VER" "$LAST_VER" )"

Close! I had to instead wrap the command in single quotes to get it working.

Done in 52f3426.

Co-authored-by: Weston Ruter <[email protected]>

codecov · 2021-06-01T19:21:45Z

Codecov Report

Merging #6302 (f0a0dab) into develop (3bb15f3) will increase coverage by 0.00%.
The diff coverage is n/a.

❗ Current head f0a0dab differs from pull request most recent head aadb449. Consider uploading reports for the commit aadb449 to get more accurate results

@@            Coverage Diff             @@
##             develop    #6302   +/-   ##
==========================================
  Coverage      75.39%   75.40%           
  Complexity      5881     5881           
==========================================
  Files            235      235           
  Lines          17787    17781    -6     
==========================================
- Hits           13411    13407    -4     
+ Misses          4376     4374    -2

Flag	Coverage Δ
javascript	`79.84% <ø> (ø)`
php	`75.20% <ø> (+<0.01%)`	⬆️
unit	`75.20% <ø> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
includes/class-amp-theme-support.php	`86.05% <0.00%> (-0.02%)`	⬇️
includes/amp-helper-functions.php	`81.89% <0.00%> (+0.19%)`	⬆️

westonruter · 2021-06-01T22:19:25Z

.github/workflows/gutenberg-packages-update.yml

@@ -25,18 +25,18 @@ jobs:
        id: last-release
        run: |
          PR_TITLE=$(gh api -X GET search/issues -f q='${{ env.QUERY }}' -f sort='created' -f order='desc' --jq '.items.[].title' | head -n 1)
-          LAST_VERSION=$(node -e "'$PR_TITLE' && console.log( '$PR_TITLE'.match('v(.+) release')[1] )")
+          LAST_VERSION=$(sed -r 's/.+ v(.+) .+/\1/' <<< "$PR_TITLE")
          echo "::set-output name=version::$(echo "$LAST_VERSION")"


In order to ensure only valid version numbers are used, this could could be checked as follows:

Suggested change

echo "::set-output name=version::$(echo "$LAST_VERSION")"

if egrep -q '^[0-9][0-9]*(\.[0-9][0-9]*)*$' <<< "$LAST_VERSION"; then

echo "::set-output name=version::$(echo "$LAST_VERSION")"

fi

And maybe exit 1 if else?

Maybe not a non-zero exit, as that would mark the job as a failure which is techincally not true... unless that's what we want?

At least the job should be skipped entirely?

Er, but at the moment there are no such merged PRs in the repo: https://github.com/ampproject/amp-wp/pulls?q=is%3Apr+author%3Aapp%2Fgithub-actions+is%3Aopen+is%3Amerged+in%3Atitle+Update+Gutenberg+packages+after

I guess in that case LAST_VER will be empty? So then maybe it should be set to 0.0.0:

Suggested change

echo "::set-output name=version::$(echo "$LAST_VERSION")"

if ! egrep -q '^[0-9][0-9]*(\.[0-9][0-9]*)*$' <<< "$LAST_VERSION"; then

LAST_VERSION='0.0.0'

fi

echo "::set-output name=version::$(echo "$LAST_VERSION")"

That works 👍.

westonruter · 2021-06-01T22:23:53Z

.github/workflows/auto-merge.yml

+        if: >
+          # Auto merge `@wordpress/` dependency PRs
+          startsWith( ${{ github.event.pull_request.title }}, 'Bump @wordpress' )


At the moment this won't do anything because the @wordpress dependencies are excluded, right?

westonruter · 2021-06-01T22:24:10Z

.github/workflows/gutenberg-packages-update.yml

+        if: steps.packages.outputs.list != 0 && steps.remote-branch.outputs.exists == 0
+        run: |
+          git push -u origin "$HEAD_BRANCH"
+          gh pr create --base "$BASE_BRANCH" --title "Update Gutenberg packages after v$VERSION release" --body "" --label dependencies


Should this also do gh pr merge --auto --merge?

Yea that works here as well, will make the change.

westonruter

LGTM

pierlon added 2 commits May 21, 2021 00:05

Add GHA workflow to auto-merge some dependency updates

11f4656

Add comment

719068f

pierlon commented May 21, 2021

View reviewed changes

pierlon marked this pull request as ready for review May 21, 2021 04:13

pierlon requested review from westonruter and schlessera May 21, 2021 04:16

pierlon self-assigned this May 21, 2021

pierlon added the Infrastructure Changes impacting testing infrastructure or build tooling label May 21, 2021

pierlon added this to the v2.2 milestone May 21, 2021

Limit workflow to running when a PR is opened

58cf9ba

Only update Gutenberg package dependencies when a new Gutenberg plugi…

4e54f17

…n update is released

pierlon mentioned this pull request May 22, 2021

Add GitHub action to auto-merge Dependabot pull requests #6298

Closed

pierlon changed the title ~~Add GHA workflow to auto-merge some dependency updates~~ Add GHA workflows to auto-merge dependency updates and bundle GB dependency updates per GB plugin release May 22, 2021

westonruter requested changes May 24, 2021

View reviewed changes

pierlon and others added 4 commits May 25, 2021 08:07

Fix typo

76dff89

Co-authored-by: Weston Ruter <[email protected]>

Add author check to search query

46b6ef7

Use args in php command

52f3426

Co-authored-by: Weston Ruter <[email protected]>

Simplify retrieval of version from PR title

f0a0dab

Co-authored-by: Weston Ruter <[email protected]>

pierlon force-pushed the enhancement/6298-automerge-dependency-prs branch from fcb0065 to f0a0dab Compare May 25, 2021 09:35

pierlon requested a review from westonruter May 25, 2021 09:37

Merge branch 'develop' into enhancement/6298-automerge-dependency-prs

aadb449

westonruter reviewed Jun 1, 2021

View reviewed changes

pierlon added 2 commits June 1, 2021 21:19

Ensure last version code is valid

72a3857

Enable auto-merge on newly created PR

c74b0d5

westonruter approved these changes Jun 2, 2021

View reviewed changes

westonruter merged commit c030292 into develop Jun 2, 2021

westonruter deleted the enhancement/6298-automerge-dependency-prs branch June 2, 2021 01:25

This was referenced Jun 2, 2021

Fix condition preventing Gutenberg packages PR from being created #6347

Merged

Remove newlines from package list before setting step output #6349

Merged

westonruter added the Changelogged Whether the issue/PR has been added to release notes. label Dec 15, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add GHA workflows to auto-merge dependency updates and bundle GB dependency updates per GB plugin release #6302

Add GHA workflows to auto-merge dependency updates and bundle GB dependency updates per GB plugin release #6302

pierlon commented May 21, 2021 •

edited

Loading

pierlon May 21, 2021

westonruter Jun 1, 2021

pierlon Jun 2, 2021

github-actions bot commented May 21, 2021 •

edited

Loading

pierlon commented May 22, 2021

westonruter May 24, 2021

pierlon May 25, 2021 •

edited

Loading

westonruter May 24, 2021

westonruter May 24, 2021

pierlon May 25, 2021

westonruter May 24, 2021

pierlon May 25, 2021

pierlon May 25, 2021 •

edited

Loading

codecov bot commented Jun 1, 2021 •

edited

Loading

westonruter Jun 1, 2021

westonruter Jun 1, 2021

pierlon Jun 2, 2021

westonruter Jun 2, 2021 •

edited

Loading

pierlon Jun 2, 2021

westonruter Jun 1, 2021

westonruter Jun 1, 2021

pierlon Jun 2, 2021

westonruter left a comment

	LAST_VERSION=$(node -e "'$PR_TITLE' && console.log( '$PR_TITLE'.match('v(.+) release')[1] )")
	LAST_VERSION=$(sed 's/.* \(v.\)./$1/' <<< "$PR_TITLE")

	run: echo "::set-output name=outdated::$(php -r "echo json_encode(version_compare('$LATEST_VER', '$LAST_VER', '>'));")"
	run: echo "::set-output name=outdated::$(php -r "echo json_encode(version_compare($argv[1], $argv[2], '>'));" "$LATEST_VER" "$LAST_VER" )"

Add GHA workflows to auto-merge dependency updates and bundle GB dependency updates per GB plugin release #6302

Add GHA workflows to auto-merge dependency updates and bundle GB dependency updates per GB plugin release #6302

Conversation

pierlon commented May 21, 2021 • edited Loading

Summary

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented May 21, 2021 • edited Loading

pierlon commented May 22, 2021

Choose a reason for hiding this comment

pierlon May 25, 2021 • 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

pierlon May 25, 2021 • edited Loading

Choose a reason for hiding this comment

codecov bot commented Jun 1, 2021 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

westonruter Jun 2, 2021 • 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

westonruter left a comment

Choose a reason for hiding this comment

pierlon commented May 21, 2021 •

edited

Loading

github-actions bot commented May 21, 2021 •

edited

Loading

pierlon May 25, 2021 •

edited

Loading

pierlon May 25, 2021 •

edited

Loading

codecov bot commented Jun 1, 2021 •

edited

Loading

westonruter Jun 2, 2021 •

edited

Loading