Skip to content

CI workflow refactor #52

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.

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

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
184 changes: 131 additions & 53 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,54 @@
name: ci

on:
- pull_request
- push
push:
branches:
- master
paths-ignore:
- '*.md'
pull_request:
types:
- opened
- edited # in case of base branch change
- synchronize
branches:
- "**"
paths-ignore:
- '*.md'

# Cancel in progress workflows
# in the scenario where we already had a run going for that PR/branch/tag but then triggered a new run
concurrency:
group: "${{ github.workflow }} ✨ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}"
cancel-in-progress: true

permissions:
contents: read

jobs:
lint:
name: Lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
persist-credentials: false
- name: Setup Node.js
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
with:
node-version: 'lts/*'

- name: Install dependencies
run: npm install --ignore-scripts --include=dev

- name: Run lint
run: node --run lint # Use `node --run` to run the script in package.json

test:
runs-on: ubuntu-20.04
name: Test
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
name:
- Node.js 0.8
Expand All @@ -31,6 +72,12 @@ jobs:
- Node.js 16.x
- Node.js 17.x
- Node.js 18.x
- Node.js 19.x
- Node.js 20.x
- Node.js 21.x
- Node.js 22.x
- Node.js 23.x
- Node.js 24.x

include:
- name: Node.js 0.8
Expand Down Expand Up @@ -59,60 +106,83 @@ jobs:
npm-i: [email protected] [email protected] [email protected]

- name: Node.js 4.x
node-version: "4.9"
node-version: "4"
npm-i: [email protected] [email protected] [email protected]

- name: Node.js 5.x
node-version: "5.12"
node-version: "5"
npm-i: [email protected] [email protected] [email protected]

- name: Node.js 6.x
node-version: "6.16"
node-version: "6"
npm-i: [email protected] [email protected] [email protected]

- name: Node.js 7.x
node-version: "7.10"
node-version: "7"
npm-i: [email protected] [email protected] [email protected]

- name: Node.js 8.x
node-version: "8.16"
npm-i: [email protected]
node-version: "8"
npm-i: [email protected] [email protected] [email protected]

- name: Node.js 9.x
node-version: "9.11"
npm-i: [email protected]
node-version: "9"
npm-i: [email protected] [email protected] [email protected]

- name: Node.js 10.x
node-version: "10.24"
npm-i: [email protected]
node-version: "10"
npm-i: [email protected] [email protected]

- name: Node.js 11.x
node-version: "11.15"
npm-i: [email protected]
node-version: "11"
npm-i: [email protected] [email protected]

- name: Node.js 12.x
node-version: "12.22"
node-version: "12"
npm-i: "[email protected]"

- name: Node.js 13.x
node-version: "13.14"
node-version: "13"
npm-i: "[email protected]"

- name: Node.js 13.x
node-version: "14.21"
- name: Node.js 14.x
node-version: "14"

- name: Node.js 15.x
node-version: "15.14"
node-version: "15"
npm-i: "[email protected]"

- name: Node.js 16.x
node-version: "16.19"
node-version: "16"

- name: Node.js 17.x
node-version: "17.9"
node-version: "17"

- name: Node.js 18.x
node-version: "18.13"
node-version: "18"

- name: Node.js 19.x
node-version: "19"

- name: Node.js 20.x
node-version: "20"

- name: Node.js 21.x
node-version: "21"

- name: Node.js 22.x
node-version: "22"

- name: Node.js 23.x
node-version: "23"

- name: Node.js 24.x
node-version: "24"

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
persist-credentials: false

- name: Install Node.js ${{ matrix.node-version }}
shell: bash -eo pipefail -l {0}
Expand All @@ -127,7 +197,12 @@ jobs:
dirname "$(nvm which ${{ matrix.node-version }})" >> "$GITHUB_PATH"

- name: Configure npm
run: npm config set shrinkwrap false
run: |
if [[ "$(npm config get package-lock)" == "true" ]]; then
npm config set package-lock false
else
npm config set shrinkwrap false
fi

- name: Remove npm module(s) ${{ matrix.npm-rm }}
run: npm rm --silent --save-dev ${{ matrix.npm-rm }}
Expand All @@ -141,8 +216,8 @@ jobs:
shell: bash
run: |
# eslint for linting
# - remove on Node.js < 12
if [[ "$(cut -d. -f1 <<< "${{ matrix.node-version }}")" -lt 12 ]]; then
# - remove on Node.js < 10
if [[ "$(cut -d. -f1 <<< "${{ matrix.node-version }}")" -lt 10 ]]; then
node -pe 'Object.keys(require("./package").devDependencies).join("\n")' | \
grep -E '^eslint(-|$)' | \
sort -r | \
Expand All @@ -159,7 +234,7 @@ jobs:
echo "node@$(node -v)"
echo "npm@$(npm -v)"
npm -s ls ||:
(npm -s ls --depth=0 ||:) | awk -F'[ @]' 'NR>1 && $2 { print $2 "=" $3 }' >> "$GITHUB_OUTPUT"
(npm -s ls --depth=0 ||:) | awk -F'[ @]' 'NR>1 && $2 { print "::set-output name=" $2 "::" $3 }'

- name: Run tests
shell: bash
Expand All @@ -171,10 +246,6 @@ jobs:
npm test
fi

- name: Lint code
if: steps.list_env.outputs.eslint != ''
run: npm run lint

- name: Collect code coverage
if: steps.list_env.outputs.nyc != ''
run: |
Expand All @@ -185,34 +256,41 @@ jobs:
fi

- name: Upload code coverage
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
if: steps.list_env.outputs.nyc != ''
with:
name: coverage
path: ./coverage
retention-days: 1

coverage:
name: Coverage
needs: test
runs-on: ubuntu-latest
permissions:
contents: read
checks: write
steps:
- uses: actions/checkout@v3

- name: Install lcov
shell: bash
run: sudo apt-get -y install lcov

- name: Collect coverage reports
uses: actions/download-artifact@v3
with:
name: coverage
path: ./coverage

- name: Merge coverage reports
shell: bash
run: find ./coverage -name lcov.info -exec printf '-a %q\n' {} \; | xargs lcov -o ./coverage/lcov.info

- name: Upload coverage report
uses: coverallsapp/github-action@master
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
persist-credentials: false

- name: Install lcov
shell: bash
run: sudo apt-get -y install lcov

- name: Collect coverage reports
uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
with:
name: coverage
path: ./coverage

- name: Merge coverage reports
shell: bash
run: find ./coverage -name lcov.info -exec printf '-a %q\n' {} \; | xargs lcov -o ./coverage/lcov.info

- name: Upload coverage report
uses: coverallsapp/github-action@648a8eb78e6d50909eff900e4ec85cab4524a45b # v2.3.6
with:
file: ./coverage/lcov.info
github-token: ${{ secrets.GITHUB_TOKEN }}