Switch from Travis CI to GitHub Actions #504

voxpelli · 2020-01-25T16:06:12Z

Some benefits:

More granular representation in the UI of which tests fails and which passes
Very easy to run tests on Windows as well

Example runs can be seen here:

https://github.com/voxpelli/eslint-plugin-unicorn/actions?query=branch%3Atooling%2Fgithub-workflows

Badges like these ones can be added to readme after workflows has been added:

sindresorhus · 2020-01-25T16:24:15Z

I dunno. GH Actions is promising, but that’s a fairly large amount of config for something the Travis file does in 19 lines.

voxpelli · 2020-01-25T22:47:01Z

@sindresorhus You can do it in fewer files, but I myself has opted for splitting them up in my repositories, to get them as fully separate workflows in the UI and logs.

It would be possible to fully replicate the Travis CI one I believe, but then the bonus of more granular feedback would get lost.

Edit: The Basic example here is eg. very small: https://github.com/actions/setup-node#usage

voxpelli · 2020-01-25T23:05:12Z

I gave it a second look to see whether I could slim the files down. Now they are pretty much are the simplest bare minimum that I can figure out, where one stills gets granular feedback in the UI.

One could smash the three different tests together even more, but I'm not sure whether it will become more readable or worse + you likely/easily lose some of the feedback in the UI.

One thing though: I do know that Other as a label is pretty useless, but it's all my brain can come up with right now 😝

fisker · 2020-01-26T03:41:51Z

@voxpelli I wrote one few month ago https://github.com/fisker/eslint-plugin-unicorn/blob/github-workflow/.github/workflows/continuous-integration.yml

sindresorhus · 2020-01-26T04:53:32Z

Use actions/checkout@v2.

voxpelli · 2020-01-26T17:04:05Z

@sindresorhus Done 👍

@fisker Nice, my only feedback on that one is that it doesn't give granular feedback on whether it's the linting/integration that fails or something else – just like the Travis tests ;) Any takeaways from when you made that one?

.github/workflows/test.yml

sindresorhus · 2020-02-01T09:54:45Z

package.json

@@ -15,7 +15,8 @@
 	},
 	"scripts": {
 		"test": "xo && nyc ava",
-		"lint": "node ./test/lint/lint.js",
+		"test-coverage": "nyc --reporter=lcov ava",
+		"lint": "node ./test/lint/lint.js && xo",


XO is now run twice, both on test and lint.

@sindresorhus Yes and no. In the GitHub CI pipe test-coverage is run rather than test. Partly to get coverage report and partly to move the xo part from being run on every Node.js version to being run just once as part of the linting flow.

So, test.yml runs test-coverage while other.yml (suggestion on better name?) runs lint and integration

I thought it was best to leave the test as is, as that's likely the one that gets run manually the most.

sindresorhus · 2020-02-01T09:55:49Z

Alright, let's do this. Can you drop the Travis file and integrate the badges?

fisker

We should use songle yml for all jobs

voxpelli · 2020-02-01T15:08:53Z

Alright, let's do this. Can you drop the Travis file and integrate the badges?

Done 👍

We should use songle yml for all jobs

I don't see the benefit of mashing them all together in one file.

Now there's at least just two files: One for those tests that don't care about which node.js version they run on and another that tests across all supported node.js versions. So all tests that are similar to one another are in the same file and those that don't really share any similarity, they are kept in separate files.

fisker · 2020-02-01T15:18:21Z

@voxpelli use one file we can use one badge, and they are not that much

voxpelli · 2020-02-01T15:21:39Z

@voxpelli use one file we can use one badge, and they are not that much

@fisker I don't think having two badges are a bug but a feature. It's to me two very different things whether linting fails or whether tests fails. Tests verifies functionality while linting verifies code quality. Getting good indicators around which one is failing is a benefit on top of Travis CI I think. (Though I do recognize that I haven't contributed a good name for the Other badge and that coupling integration and linting in the same file kind of defeats the purpose of the separation, hence why I had three files initially)

@sindresorhus I did a rebase + squash as well as removed Node 8 to match master + added Node.js 13 as a separate commit. Any reason why Node.js 13 isn't included right now?

fisker · 2020-02-01T15:24:31Z

.github/workflows/test.yml

+      - uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.github_token }}
+          parallel-finished: true


On my experience, this not right, seem need another job wait for matrix, not sure. I tried in this way before.

So I dont use parallel https://github.com/fisker/id-placeholder/blob/ae506a0069bb459f6100f2c317f377ba9f8651de/.github/workflows/continuous-integration.yml#L52

Also, this action some times fail for no reason, issue can found on their repo, so I use continue-on-error

The parallel-finished is what they document should be used when running multiple tests in parallel: https://github.com/coverallsapp/github-action#inputs

I added the continue-on-error on error now 👍 Good feedback!

.github/workflows/test.yml

fisker

I know that, also here says

Set to true in the last job, after the other parallel jobs steps have completed, this will send a webhook to Coveralls to set the build complete.

on matrix, the other parallel jobs steps have not completed.

fisker · 2020-02-01T15:47:57Z

Like I said, I'm not sure how to make it work, I tried this way before, but seems not right

voxpelli · 2020-02-01T15:49:39Z

Yeah, in the example it does like what I did: https://github.com/coverallsapp/github-action/blob/master/README.md#complete-parallel-job-example 🤔

sindresorhus · 2020-02-01T16:18:48Z

I don't really see the value of two badges either. You have to click the badge regardless to see the details, and neither should be failing.

fisker · 2020-02-01T16:49:55Z

But this example is not on matrix.

We can skip changing this part, just keep them.
If we find any problem later, we can fix then.

fisker · 2020-02-01T16:51:51Z

One more thing eslint-plugin-ava already did this

https://github.com/avajs/eslint-plugin-ava/blob/master/.github/workflows/ci.yml

fisker · 2020-02-01T16:53:37Z

.github/workflows/test.yml

+    name: Node.js ${{ matrix.node_version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:


fail-fast: false is needed here

fisker · 2020-02-01T18:23:52Z

@voxpelli found a project use parallel, check the commit history of this file, guess I am right

https://github.com/lo1tuma/eslint-plugin-mocha/blob/e40722d1691f087550a1146b781bcf25631f74c8/.github/workflows/ci.yml

fisker · 2020-02-11T04:32:25Z

package.json

+		"rules": {
+			"import/order": "off"
+		}


This is really weird, see

https://github.com/voxpelli/eslint-plugin-unicorn/runs/437762645?check_suite_focus=true

import-js/eslint-plugin-import#1651

fisker · 2020-02-11T04:39:13Z

@voxpelli I did some adjustment.

@sindresorhus You may want take a look.

sindresorhus · 2020-02-11T17:12:43Z

.github/workflows/ci.yml

+          continue-on-error: true
+          with:
+              github-token: ${{ secrets.github_token }}
+              parallel-finished: true


Why cannot this just be part of the test job? I don't see what it does differently from the code in the test job either.

This job send a webhook to coveralls, need wait for all test job finished.

See #504 (comment) and #504 (comment)

Why though? We only need coveralls to run in one of the test job, not all.

I removed parallel, and add a condition. only run on node.js 12 on linux

package.json

fisker · 2020-02-11T18:14:09Z

@sindresorhus Do you want a nice title on each task? If not, I think we are good to go

sindresorhus · 2020-02-11T18:21:24Z

readme.md

@@ -1,4 +1,4 @@
-# eslint-plugin-unicorn [![Build Status](https://travis-ci.org/sindresorhus/eslint-plugin-unicorn.svg?branch=master)](https://travis-ci.org/sindresorhus/eslint-plugin-unicorn) [![Coverage Status](https://coveralls.io/repos/github/sindresorhus/eslint-plugin-unicorn/badge.svg?branch=master)](https://coveralls.io/github/sindresorhus/eslint-plugin-unicorn?branch=master)
+# eslint-plugin-unicorn ![Build Status](https://github.com/sindresorhus/eslint-plugin-unicorn/workflows/CI/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/sindresorhus/eslint-plugin-unicorn/badge.svg?branch=master)](https://coveralls.io/github/sindresorhus/eslint-plugin-unicorn?branch=master)


Shouldn't the badge be linkified?

sindresorhus · 2020-02-11T18:21:48Z

Do you want a nice title on each task?

Nah

…-plugin-unicorn into tooling/github-workflows

fisker · 2020-02-11T18:25:56Z

Thanks @voxpelli

fisker · 2020-02-11T18:35:21Z

Looks good

CI:

https://github.com/sindresorhus/eslint-plugin-unicorn/actions/runs/37731558

Coverage:

https://coveralls.io/github/sindresorhus/eslint-plugin-unicorn?branch=master

https://coveralls.io/builds/28664112

sindresorhus requested changes Feb 1, 2020

View reviewed changes

fisker requested changes Feb 1, 2020

View reviewed changes

voxpelli requested a review from sindresorhus February 1, 2020 15:09

voxpelli added 4 commits February 1, 2020 16:17

Add GitHub CI tasks

050b59e

Test on Windows as well

eb961c1

Test on Node 13 as well

efde3b6

Remove travis file and replace badges

2d81a5c

fisker reviewed Feb 1, 2020

View reviewed changes

.github/workflows/test.yml Outdated Show resolved Hide resolved

voxpelli added 3 commits February 1, 2020 16:41

Add suggested continue-on-error: true

1e094d0

Add pull_request event

7487064

Remove accidental line break in README

c7ffbd3

fisker reviewed Feb 1, 2020

View reviewed changes

fisker added 5 commits February 11, 2020 12:00

Merge tasks

394da1a

Add fail-fast

6751832

Fix script

91dd5b5

Merge branch 'master' into tooling/github-workflows

b9a65f6

update reporter disable import/order

13f5e60

fisker reviewed Feb 11, 2020

View reviewed changes

niksy mentioned this pull request Feb 11, 2020

Investigate GitHub CI and actions niksy/generator-paleta#155

Closed

sindresorhus requested changes Feb 11, 2020

View reviewed changes

sindresorhus changed the title ~~Draft on possibly using GitHub CI/Actions rather than Travis CI~~ Switch from Travis CI to GitHub Actions Feb 11, 2020

fisker added 5 commits February 12, 2020 01:47

nyc config

e1fdcb5

Remove parallel for coveralls

87e7375

Add condition for coveralls

f8ceedc

Fix condition

ef390cf

Remove continue-on-error for now

108eb6e

fisker approved these changes Feb 11, 2020

View reviewed changes

Update package.json

d9961a1

sindresorhus reviewed Feb 11, 2020

View reviewed changes

fisker added 2 commits February 12, 2020 02:22

Add missing link

0a2c180

Merge branch 'tooling/github-workflows' of github.com:voxpelli/eslint…

67f38e9

…-plugin-unicorn into tooling/github-workflows

fisker merged commit 34de844 into sindresorhus:master Feb 11, 2020

fisker mentioned this pull request Feb 11, 2020

Enable import/order rule #521

Closed

voxpelli mentioned this pull request Nov 4, 2020

Add GitHub CI setup sindresorhus/type-fest#139

Merged

		@@ -1,4 +1,4 @@
		# eslint-plugin-unicorn [![Build Status](https://travis-ci.org/sindresorhus/eslint-plugin-unicorn.svg?branch=master)](https://travis-ci.org/sindresorhus/eslint-plugin-unicorn) [![Coverage Status](https://coveralls.io/repos/github/sindresorhus/eslint-plugin-unicorn/badge.svg?branch=master)](https://coveralls.io/github/sindresorhus/eslint-plugin-unicorn?branch=master)
		# eslint-plugin-unicorn ![Build Status](https://github.com/sindresorhus/eslint-plugin-unicorn/workflows/CI/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/sindresorhus/eslint-plugin-unicorn/badge.svg?branch=master)](https://coveralls.io/github/sindresorhus/eslint-plugin-unicorn?branch=master)

Switch from Travis CI to GitHub Actions #504

Switch from Travis CI to GitHub Actions #504

Conversation

voxpelli commented Jan 25, 2020 • edited

sindresorhus commented Jan 25, 2020

voxpelli commented Jan 25, 2020 • edited

voxpelli commented Jan 25, 2020

fisker commented Jan 26, 2020

sindresorhus commented Jan 26, 2020

voxpelli commented Jan 26, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sindresorhus commented Feb 1, 2020

fisker left a comment

Choose a reason for hiding this comment

voxpelli commented Feb 1, 2020

fisker commented Feb 1, 2020

voxpelli commented Feb 1, 2020

fisker Feb 1, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fisker left a comment • edited

Choose a reason for hiding this comment

fisker commented Feb 1, 2020

voxpelli commented Feb 1, 2020

sindresorhus commented Feb 1, 2020

fisker commented Feb 1, 2020

fisker commented Feb 1, 2020

Choose a reason for hiding this comment

fisker commented Feb 1, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fisker commented Feb 11, 2020

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

fisker commented Feb 11, 2020

Choose a reason for hiding this comment

sindresorhus commented Feb 11, 2020

fisker commented Feb 11, 2020

fisker commented Feb 11, 2020 • edited

voxpelli commented Jan 25, 2020 •

edited

voxpelli commented Jan 25, 2020 •

edited

fisker Feb 1, 2020 •

edited

fisker left a comment •

edited

fisker commented Feb 11, 2020 •

edited