Switch to GitHub Actions #143

desrosj · 2021-02-19T20:11:07Z

This PR adds an example workflow for implementing the test runner using GitHub Actions.

.travis.yml

the hoster should be able to choose between different ways to run the `phpunit-test-runner`

Otherwise the reporting will be skipped if phpunit runs into errors.

pfefferle · 2021-05-21T08:35:26Z

@desrosj can you have a look at the latest changes?

desrosj

Thanks for running with this, @pfefferle! I haven't looked into the reason why the workflow run is failing, but left some general feedback for the workflows themselves.

.github/workflows/tests.yml

desrosj · 2021-07-07T13:56:24Z

.github/workflows/tests.yml

+    steps:
+      - name: Cancel previous runs of this workflow (pull requests only)
+        if: ${{ github.event_name == 'pull_request' }}
+        uses: styfle/cancel-workflow-action@0.8.0


For 3rd party actions, using version numbers and ranges is OK, but there are some tradeoffs. The Security hardening page in the GHA docs details these.

In Gutenberg and WordPress Core, we have adopted the pattern of using the full length commit SHA followed by an inline # v0.8.0 comment.

@desrosj

thanks @desrosj

pfefferle · 2021-08-03T13:37:15Z

@desrosj the test fails, because it is not configured properly. This repo should only be a whitepaper/example for hosters, how they can run the unit-tests with different action or CI/CD services.

This reverts commit 6080a4e.

This follows the GitHub Actions security best practices when using third-party actions. For more info, see https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions.

…e.wordpress.org/hosting/test-results-getting-started/.

GHA will not be the preferred way to run the tests for everyone. This includes a condition to disable it by default.

desrosj · 2021-08-18T16:29:28Z

@pfefferle I've made a handful of updates to polish the workflow. I think it's in a great state. I do think there is one thing we need to discuss before merging.

Since the workflow is an example for how hosts can run the tests using GHA, I think it should be disabled by default. I've added a condition in the workflow to never run, and documented that the implementer should remove that if GHA is preferred.

pfefferle · 2021-09-09T10:12:32Z

@desrosj I have problems with the caching of actions/setup-node:

Found in cache @ /opt/hostedtoolcache/node/14.17.6/x64
/opt/hostedtoolcache/node/14.17.6/x64/bin/npm config get cache
/home/runner/.npm
Error: Dependencies lock file is not found in /home/runner/work/***/***. Supported file patterns: package-lock.json,yarn.lock

pfefferle · 2021-09-09T10:13:34Z

Since the workflow is an example for how hosts can run the tests using GHA, I think it should be disabled by default. I've added a condition in the workflow to never run, and documented that the implementer should remove that if GHA is preferred.

I like the idea! 👍

desrosj · 2021-09-13T15:44:51Z

@desrosj I have problems with the caching of actions/setup-node:

Found in cache @ /opt/hostedtoolcache/node/14.17.6/x64
/opt/hostedtoolcache/node/14.17.6/x64/bin/npm config get cache
/home/runner/.npm
Error: Dependencies lock file is not found in /home/runner/work/***/***. Supported file patterns: package-lock.json,yarn.lock

Ah, yes a lock file must be present for the NPM caching to configure correctly. But I'm not sure this can be configured because the npm install step happens in the middle of prepare.php. For now, I'm thinking we just remove the caching aspect.

This is difficult to set up because a `package-lock.json` file is required in order to create a cache key. In this context, the lock file should be the one from WordPress Core. But since WordPress is not checked out until the `prepare.php` step, caching cannot be configured before hand.

desrosj · 2021-09-13T15:49:03Z

Updated! I think this one is looking pretty good!

pfefferle · 2021-09-14T08:06:47Z

works like a charm 👍

pfefferle

LGTM!

pfefferle · 2021-09-15T09:31:37Z

Thanks a lot @desrosj !

getsource · 2021-09-15T09:35:17Z

Thanks so much @pfefferle and @desrosj !! 🎉🎉🎉

First attempt to use GitHub Actions.

9d18725

desrosj self-assigned this Feb 19, 2021

Use correct names. Don't run on push for PRs.

ec86ffa

pfefferle reviewed Feb 20, 2021

View reviewed changes

.travis.yml Outdated Show resolved Hide resolved

pfefferle added 4 commits May 19, 2021 10:24

generate .ssh folder if not existent

3358d55

re-add travis file

d551cae

the hoster should be able to choose between different ways to run the `phpunit-test-runner`

add scheduler example

66ced63

add env vars as example

cb4576c

pfefferle self-assigned this May 19, 2021

pfefferle added the enhancement label May 19, 2021

pfefferle added 2 commits May 19, 2021 10:50

Add continue-on-error: true for phpunit

c2fe22c

Otherwise the reporting will be skipped if phpunit runs into errors.

Add some doc

9972040

pfefferle marked this pull request as ready for review May 21, 2021 08:34

pfefferle requested a review from getsource May 21, 2021 08:34

desrosj commented Jul 7, 2021

View reviewed changes

change caching

6080a4e

thanks @desrosj

pfefferle and others added 9 commits August 4, 2021 10:19

Revert "change caching"

1631b97

This reverts commit 6080a4e.

Use GHA native concurrency to cancel duplicate workflow runs.

cdbe3f5

Use caching built into actions/setup-node.

aabc6d4

Use commit SHAs for third-party actions.

a47082b

This follows the GitHub Actions security best practices when using third-party actions. For more info, see https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions.

Improve documentation.

dcc7b2b

Change the schedule example to match the suggestions on https://mak…

eddcad5

…e.wordpress.org/hosting/test-results-getting-started/.

More documentation improvements.

ec143fa

Remove Remove push and pull_request events.

7c72203

Add a condition to disable the workflow.

01652cb

GHA will not be the preferred way to run the tests for everyone. This includes a condition to disable it by default.

pfefferle approved these changes Sep 14, 2021

View reviewed changes

pfefferle merged commit 9957fe4 into master Sep 15, 2021

pfefferle deleted the switch-to-github-actions branch September 15, 2021 09:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Switch to GitHub Actions #143

Switch to GitHub Actions #143

desrosj commented Feb 19, 2021 •

edited

pfefferle commented May 21, 2021

desrosj left a comment

desrosj Jul 7, 2021

pfefferle commented Aug 3, 2021

desrosj commented Aug 18, 2021

pfefferle commented Sep 9, 2021

pfefferle commented Sep 9, 2021

desrosj commented Sep 13, 2021

desrosj commented Sep 13, 2021

pfefferle commented Sep 14, 2021

pfefferle left a comment

pfefferle commented Sep 15, 2021

getsource commented Sep 15, 2021

Switch to GitHub Actions #143

Switch to GitHub Actions #143

Conversation

desrosj commented Feb 19, 2021 • edited

pfefferle commented May 21, 2021

desrosj left a comment

Choose a reason for hiding this comment

desrosj Jul 7, 2021

Choose a reason for hiding this comment

pfefferle commented Aug 3, 2021

desrosj commented Aug 18, 2021

pfefferle commented Sep 9, 2021

pfefferle commented Sep 9, 2021

desrosj commented Sep 13, 2021

desrosj commented Sep 13, 2021

pfefferle commented Sep 14, 2021

pfefferle left a comment

Choose a reason for hiding this comment

pfefferle commented Sep 15, 2021

getsource commented Sep 15, 2021

desrosj commented Feb 19, 2021 •

edited