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.

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

ci: setup checks for update of branch main and for PRs #86

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
50 changes: 50 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: CI

# configure concurrency: cancel pending and in-progress workflow runs if a new commit to the same branch is pushed (`github.head_ref` is the source branch of PRs, `github.ref_name` is the branch name of non-PR events)
concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.ref_name }}
cancel-in-progress: true

on:
push:
branches:
- main
pull_request:
branches:
- main
types:
- opened # new PR was created
- synchronize # the last commit of the `head_ref` (= source branch) changed, e.g. a new commit was pushed or the source branch was rebased
- ready_for_review # the PR switched from draft to non-draft
- reopened # PR had been closed and got reopened

jobs:
check:
name: Checks (typechecking, linting, formatting)
# run only if triggered by push on a branch or by a PR event for a PR which is not a draft
if: ${{ !github.event.pull_request || github.event.pull_request.draft == false }}
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4

- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version-file: ".nvmrc"
cache: npm

- name: Install dependencies
run: |
npm ci

- name: Typecheck everything (tsc)
run: |
npm run build:types

- name: Lint everything (eslint)
run: |
npm run lint

- name: Check formatting of everything (prettier)
run: |
npm run fmt
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,11 @@
"build:preview": "vite preview",
"build:readme": "node tools/update-readme.js",
"start": "vite",
"build:types": "tsc",
"lint": "npm-run-all --parallel lint:js",
"lint:fix": "npm-run-all --parallel lint:fix:*",
"lint:js": "eslint .",
"lint:fix:js": "eslint . --fix",
"lint:js": "eslint --max-warnings 0 .",
"lint:fix:js": "eslint --max-warnings 0 . --fix",
"fmt": "prettier --check .",
"fmt:fix": "prettier --write ."
},
Expand Down