ci: move format, lint and test jobs to GitHub Actions

[merlinnot]

This does the following:

• Check formatting using latest Ubuntu, Node.js 12
• Run ESLint using latest Ubuntu, Node.js 12
• Run tests across operating systems and Node.js versions

Some trickery is used to cache ESLint results. npm cache is mostly straightforward, with a one workaround for Windows. Both explained in comments.

I renamed prettier step to format. Why? Because it's easier to understand for contributors. There are multiple formatters available, not everyone knows what Prettier is (I personally love it and use all the time, but we should be inclusive). Name "format" is more understandable. Same for lint:fix and format:fix -> no surprises, self-explanatory. Hope you'll like the change.

You can see it in action here, I made a PR on my branch: https://github.com/merlinnot/nock/pull/1/checks

GitHub Actions go GA in five days. To start running it today, you need to enable it for the repo here: https://github.com/features/actions (open for everyone).

For the last two steps I'll create separate PRs.

Resolves #1792

[paulmelnikow]

This looks awesome to me! I left a few small comments and questions.

I’m not exactly sure how to on Actions for the repo or what is needed to make this run. It’s already turned on for the org 🤔

[merlinnot]

I’m not exactly sure how to on Actions for the repo or what is needed to make this run. It’s already turned on for the org 🤔

Then I guess it should work once we merge it 🤔 I think we can merge it and test out, I can't find precise docs on this. We can always revert if it doesn't work for some reason 😄

[mastermatt]

I don't have much experience with Actions, but I'm a fan of the idea

[merlinnot]

@paulmelnikow Shall we get it merged?

[paulmelnikow]

It seems like perhaps there isn't a way to run this on the nock repo until this gets merged so I'd like to go ahead and do that.

One concern I have is if tests are no longer run in Travis, the semantic-release pipeline will not be dependent on tests. Do you think you could update the Travis config to run tests on master before releasing it? I think @gr2m has done a lot of work on getting semantic-release to run in Actions so I think it'll be possible to do that, though that isn't blocking and this has been open a long time.

[gr2m]

One concern I have is if tests are no longer run in Travis, the semantic-release pipeline will not be dependent on tests

Actually I think that is a good think. We have enforced the pull request workflow, nobody should push to master directly. With that, we don't need to run tests on master, because nothing can be merged without the green check from the tests. Once merged, semantic-release should just do its thing.

It's super simple to run semantic-release from Actions, too. I do it all the time.

Here is an example setup of mine

• https://github.com/octokit/core.js/blob/master/.github/workflows/test.yml
• https://github.com/octokit/core.js/blob/master/.github/workflows/release.yml

For the release flow, we need to create add the NPM_TOKEN secret to the repo

We can do a follow up PR after we merge this to move the relaese to Actions, too.

[gr2m]

We can move that to an action, too. I wrote about it here: https://dev.to/gr2m/automate-updates-of-prettier-standard-and-other-javascript-linting-tools-using-github-actions-nko

[merlinnot]

Sure, we can. Although I'd prefer to do it in a separate PR instead of making this one even larger. Is it ok with you? Seems like it doesn't have to be merged at the same time.

[gr2m]

Absolutely, I'd suggest the same. Sorry, I should have said so

[merlinnot]

@paulmelnikow I understand that since "branch up to date" requirement is enabled, you're ok with merging it as-is? I think it's good to have this setting enabled, so the master branch is always healthy.

[paulmelnikow]

Yup, it looks good to me! @gr2m does this look good to you?

[gr2m]

moved to #1870 to see how the jobs run

[gr2m]

@merlinnot any reason why you put all the jobs in a single workflow? I would prefer to split them up into multiple *.yml workflow files. It would also allow us to run the tests on greenkeeper/** branches, the same is not necessary for the linting

[merlinnot]

Yes, there are actually some reasons to do so. For Greenkeeper itself I see two

• ability to use Merge me! Action to automatically merge pull requests from Greenkeeper when the CI passes (https://github.com/ridedott/merge-me-action)
• Greenkeeper updates also include updates to the linting and formatting tools themselves, which might cause the branch not to pass cleanly anymore (eg. when new rules or fixes are introduced). That should be caught before merging to master, so I'd argue that lint and format tasks should run for dependency updates too.

[mastermatt]

so I'd argue that lint and format tasks should run for dependency updates too.

I agree with this.

[gr2m]

Greenkeeper updates also include updates to the linting and formatting tools themselves, which might cause the branch not to pass cleanly anymore (eg. when new rules or fixes are introduced). That should be caught before merging to master, so I'd argue that lint and format tasks should run for dependency updates too.

I would create separate actions that run lint:fix / format:fix and commits the changes back to pull requests coming from Greenkeeper for prettier an eslint, like this: https://github.com/octokit/core.js/blob/master/.github/workflows/update-prettier.yml

That will have the benefit that the PRs will fix themselves, we won't need to run the commands and push back the changes manually

[merlinnot]

For the updates to be pushed back to the branch it doesn't really matter if it's a single file or multiple files, right? While I personally don't mind doing or not doing it (both have pros and cons), I committed to implementing it somewhere above, it's just that I'd like to do it in a separate PR, so that it doesn't grow too much. Small steps. Is that ok with you, or do you feel the need to have this feature in this particular PR?

[merlinnot]

Oh, and you can see this particular branch being built here: merlinnot#1

[gr2m]

All sounds good to me. Great work @merlinnot 💐

[nockbot]

🎉 This PR is included in version 11.8.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀