Merge pull request #69 from gflohr/ci-workflow

CI Workflow

.github/workflows/ci-quick.yaml

@@ -0,0 +1,34 @@
+name: CI - Test Suite
+
+on:
+  push:
+    branches:
+      - '**'
+
+jobs:
+  test:
+    name: Test on ${{ matrix.os }} with Node.js ${{ matrix.node-version }}
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        node-version: [22]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Set up Bun
+        uses: oven-sh/setup-bun@v2
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Run tests
+        run: bun run test

.github/workflows/ci.yaml

@@ -0,0 +1,48 @@
+name: CI - Test Suite
+
+on:
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  test:
+    name: Test on ${{ matrix.os }} with Node.js ${{ matrix.node-version }}
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        node-version: [18, 20, 22]
+        include:
+        - node-version: '22'
+          os: ubuntu-latest
+          coverage: true
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Set up Bun
+        uses: oven-sh/setup-bun@v2
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Run tests
+        run: bun run test
+
+      - name: Test with coverage
+        if: ${{ matrix.coverage }}
+        run: bun run test:cov
+
+      - name: Upload coverage
+        uses: coverallsapp/github-action@v2
+        if: ${{ matrix.coverage }}
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -4,6 +4,10 @@
 		width="256" height="256" />
 </p>
 
+[![licence](https://img.shields.io/badge/licence-WTFPL-blue)](http://www.wtfpl.net/)
+[![price](https://img.shields.io/badge/price-FREE-green)](https://github.com/gflohr/qgoda/blob/main/LICENSE)
+[![coverage](https://img.shields.io/coverallsCoverage/github/gflohr/e-invoice-eu?branch=main)](https://coveralls.io/github/gflohr/e-invoice-eu?branch=main)
+
 # E-Invoice-EU
 
 Free and open source tool chain for generating EN16931 conforming invoices (Factur-X/ZUGFeRD, UBL, CII, XRechnung) from popular spreadsheet
@@ -146,7 +150,7 @@ You can achieve similar results with these projects:
 
 ## Pre-requisites
 
-- NodeJS 20.x
+- NodeJS 17 or newer (currently tested with NodeJS 18, 20, and 22)
 - A package manager like bun, npm, yarn, pnpm, ...
 
 ## Installation

package.json

@@ -15,9 +15,6 @@
 		"@nestjs/core": "^10.4.15",
 		"@nestjs/platform-express": "^10.4.15",
 		"@nestjs/swagger": "^8.1.0",
-		"@types/got": "^9.6.12",
-		"@types/jsdom": "^21.1.7",
-		"@types/xml2js": "^0.4.14",
 		"ajv": "^8.17.1",
 		"class-validator": "^0.14.1",
 		"got": "^14.4.5",
@@ -42,12 +39,14 @@
 		"@types/express": "^5.0.0",
 		"@types/jest": "^29.5.14",
 		"@types/js-yaml": "^4.0.9",
+		"@types/jsdom": "^21.1.7",
 		"@types/jsonpath-plus": "^5.0.5",
 		"@types/multer": "^1.4.12",
 		"@types/node": "^22.10.2",
 		"@types/semver": "^7.5.8",
 		"@types/supertest": "^6.0.2",
 		"@types/tmp": "^0.2.6",
+		"@types/xml2js": "^0.4.14",
 		"@typescript-eslint/eslint-plugin": "^8.18.2",
 		"@typescript-eslint/parser": "^8.18.2",
 		"ajv-cli": "^5.0.0",