Feat/ci checks (#26)

* test: husky integration check * build: add ci-checks in github workflow * Apply suggestions from Daniel in code review Co-authored-by: Daniel Lenksjö <[email protected]> * fix: add single job for main.yml * feat: add prettierignore file * fix: format check instead of overwrite --------- Co-authored-by: Daniel Lenksjö <[email protected]>
WebOfTrust · Sep 16, 2024 · 448b5fe · 448b5fe
1 parent 7f9781e
commit 448b5fe
Show file tree

Hide file tree

Showing 10 changed files with 622 additions and 18 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -0,0 +1,33 @@
+name: CI Workflow
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: Run ESLint
+        run: npm run lint
+
+      - name: Run Prettier Formatter
+        run: npm run format:check
+
+      - name: Check TypeScript Types
+        run: npm run tsc
+
+      - name: Run Tests
+        run: npm run test
+
+      - name: Build Application
+        run: npm run build
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,2 @@
+npx lint-staged
+npm run test
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1 @@
+examples
diff --git a/README.md b/README.md
@@ -1,7 +1,6 @@
 # polaris-web
 
-
-##  Getting started
+## Getting started
 
 See [web-react](./examples/web-react/src/App.tsx) for an example react web app that uses this library to communicate with a signify browser extension.
 
@@ -10,7 +9,6 @@ To test the example,
 - `npm install`
 - `npm -w web-react start`
 
-
 To view generated documentation,
 
 - `npm install`