Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup CI #8

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Setup CI #8

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
08ea6a8
Setup CI
rodion-arr Dec 17, 2020
4b5b5f0
Fix author field on CI
rodion-arr Dec 17, 2020
5dab052
Fix Node.js v10 support
rodion-arr Dec 21, 2020
3038f88
Remove night scheduler
rodion-arr Dec 21, 2020
955c1f8
Remove v15, add v16
rodion-arr Jul 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Node.js CI

on:
schedule:
- cron: '23 4 * * *' # Once, nightly
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think github started disabling these sort of nightly runs. What value do you see in them when we also run on PR and pushes to main?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are using this setup in wiby and I assumed this can be also applied here.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would love to hear the reasoning behind the decision. In projects which are not active daily from multiple contributors I do not usually see the point in a nightly build. I guess I just think of a nightly as a way to integration test many in-flight features from different engineers, so without that it seems better to just test each commit on a PR branch and main.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed it for now and maybe we can kindly summon @dominykas here to add more thoughts regarding night scheduler.

push:
branches:
- main
pull_request:

jobs:

test:

runs-on: ubuntu-latest

strategy:
matrix:
node-version: [ 15, 14, 12, 10 ]

steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- run: npm install
- run: npm run tests-only
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO, a lint failure is a test failure. Is there a reason not to also fail on lint errors and so just run npm t in all of them? I have in the past seen the lint configuration fail in a certain version of node, and if that is the case I think we would want to know.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't really have strong opinion here, from my side both variants are OK, so if you'd like to remove separate lint job and run lint on every node version, please let me know.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It keeps it simple, but I would be interested in hearing others opinions on the topic. Lets not consider this a blocker, and if no one shares an opinion we can merge and revisit later.


lint:

runs-on: ubuntu-latest

strategy:
matrix:
node-version: [ 14 ]

steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- run: npm install
- run: npm run lint
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![NPM Version](https://img.shields.io/npm/v/create-pkg.svg)](https://npmjs.org/package/create-pkg)
[![NPM Downloads](https://img.shields.io/npm/dm/create-pkg.svg)](https://npmjs.org/package/create-pkg)
[![test](https://github.com/pkgjs/create/workflows/Test/badge.svg)](https://github.com/pkgjs/create/actions?query=workflow%3ATest)
[![test](https://github.com/pkgjs/create/workflows/Node.js%20CI/badge.svg)](https://github.com/pkgjs/create/actions?query=workflow%3A%22Node.js+CI%22)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/standard/standard)

## Usage
Expand Down
5 changes: 4 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,10 @@
"create-package": "bin/create-package"
},
"scripts": {
"test": "standard && mocha --timeout=60000",
"lint": "standard",
"pretest": "npm run lint",
"test": "npm run tests-only",
"tests-only": "mocha --timeout=60000",
"test:debug": "mocha --inspect --inspect-brk --timeout=0",
"release": "npm t && standard-version && npm publish",
"postpublish": "git push origin && git push origin --tags"
Expand Down
3 changes: 2 additions & 1 deletion test/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ suite(pkg.name, () => {
cwd: fix.TMP,
push: false,
silent: true,
githubRepo: '__tmp'
githubRepo: '__tmp',
author: 'Unit test'
}, barePrompt)
})
})