From 71aae357c9a5d7cef6e0c212a413e202a4387a4e Mon Sep 17 00:00:00 2001 From: Severin Kaderli Date: Fri, 26 Jan 2024 22:55:04 +0100 Subject: [PATCH] Update README.md Signed-off-by: Severin Kaderli --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 5c59736..0cb851b 100644 --- a/README.md +++ b/README.md @@ -10,3 +10,29 @@ Add the configuration in the `package.json` file: "prettier": "@severinkaderli/prettier-config" } ``` + +# CI +The formatting can be checked using the following job in GitHub-compatible workflows. + +```yaml +check-format: + name: Check formatting + runs-on: ubuntu-latest + steps: + - name: Checkout the repository + uses: actions/checkout@v4 + + - name: Install Node.js + uses: actions/setup-node@v3 + with: + node-version: 20 + + - name: Add custom npm package registry + run: npm config set @severinkaderli:registry https://git.kaderli.dev/api/packages/severinkaderli/npm/ + + - name: Install dependencies + run: npm ci + + - name: Check formatting + run: npm run format:check +```