chore: Improvements (#165)

Signed-off-by: Oğuzhan Durgun <[email protected]>

.github/dependabot.yml

@@ -2,10 +2,18 @@ version: 2
 updates:
   - package-ecosystem: 'npm'
     directory: '/'
+    labels:
+      - 'area/ci'
+      - 'bots'
+      - 'kind/chore'
     schedule:
       interval: 'monthly'
 
   - package-ecosystem: 'github-actions'
     directory: '/'
+    labels:
+      - 'area/ci'
+      - 'bots'
+      - 'kind/chore'
     schedule:
       interval: 'monthly'

.github/workflows/ci.yml

@@ -6,70 +6,29 @@ on:
       - main
 
 jobs:
-  buildtest:
-    name: Build and Unit Test
+  build-test-check-and-use:
+    name: Build, Test, Check and Use
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout
+        uses: actions/checkout@v4
 
-      - name: Set Node.js 20
-        uses: actions/setup-node@v4
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          node-version: 20.x
-
-      - name: Print Node.js and npm version
-        run: |
-          node --version
-          npm --version
+      - name: Set up pnpm
+        uses: pnpm/action-setup@v3
 
-      - run: |
-          npm install
-
-      - run: |
-          npm run all
-
-  use:
-    name: Use
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set Node.js 20
+      - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          node-version: 20.x
-
-      - name: Print Node.js and npm version
-        run: |
-          node --version
-          npm --version
-
-      - uses: cerbos/cerbos-setup-action@v1
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          version: 'latest'
-
-      - uses: ./
-
-  checkdist:
-    name: Check dist/index.js
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set Node.js 20
-        uses: actions/setup-node@v4
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          node-version: 20.x
+          node-version-file: '.node-version'
 
       - name: Install dependencies
-        run: npm ci --legacy-peer-deps
+        run: |
+          pnpm install --frozen-lockfile
 
-      - name: Rebuild the dist/ directory
-        run: npm run build
+      - name: Run all
+        run: |
+          npm run all
 
       - name: Compare the expected and actual dist/ directories
         run: |
@@ -79,3 +38,13 @@ jobs:
             exit 1
           fi
         id: diff
+
+      - uses: cerbos/cerbos-setup-action@v1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          version: 'latest'
+
+      - name: Use action
+        uses: ./
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,3 +1,6 @@
+.vscode
+.idea
+
 # Dependency directory
 node_modules
 

.node-version

@@ -0,0 +1 @@
+20.18.0

README.md

@@ -1,18 +1,17 @@
 # Cerbos Compile Action
 
-A GitHub action to validate Cerbos policies using the compiler and run policy tests if there are any. 
+A GitHub action to validate Cerbos policies using the compiler and run policy tests if there are any.
 
 Cerbos helps you super-charge your authorization implementation by writing context-aware access control policies for your application resources. Find out more about Cerbos using the following resources:
 
-* [Cerbos website](https://cerbos.dev)
-* [Cerbos documentation](https://docs.cerbos.dev)
-* [Cerbos GitHub repository](https://github.com/cerbos/cerbos)
-* [Cerbos Slack community](http://go.cerbos.io/slack)
+- [Cerbos website](https://cerbos.dev)
+- [Cerbos documentation](https://docs.cerbos.dev)
+- [Cerbos GitHub repository](https://github.com/cerbos/cerbos)
+- [Cerbos Slack community](http://go.cerbos.io/slack)
 
 ## Usage
 
-Use the [cerbos-setup-action](https://github.com/cerbos/cerbos-setup-action) to install Cerbos binaries. Then use this action to validate and test your Cerbos policies. See the [documentation](https://docs.cerbos.dev/cerbos/latest/policies/compile.html) for more information about how to compile policies and author policy tests. 
-
+Use the [cerbos-setup-action](https://github.com/cerbos/cerbos-setup-action) to install Cerbos binaries. Then use this action to validate and test your Cerbos policies. See the [documentation](https://docs.cerbos.dev/cerbos/latest/policies/compile.html) for more information about how to compile policies and author policy tests.
 
 ```yaml
 - uses: actions/checkout@v2
@@ -25,3 +24,27 @@ Use the [cerbos-setup-action](https://github.com/cerbos/cerbos-setup-action) to
   with:
     policyDir: policies
 ```
+
+## Development
+
+### Prerequisites
+
+You'll need to install
+
+- Node.js, matching the version specified in our [.node-version](../.node-version) file
+
+  - A version manager that supports this file is recommended, for example [n](https://github.com/tj/n#readme).
+    Note that [nvm](https://github.com/nvm-sh/nvm) [does not](https://github.com/nvm-sh/nvm/issues/794).
+
+- pnpm, matching the version specified in our [package.json](./package.json) file
+
+  - After installing Node.js, you can enable [Corepack](https://nodejs.org/api/corepack.html) to transparently install the correct `pnpm` version:
+    ```console
+    $ corepack enable
+    ```
+
+### Build
+
+```
+pnpm run all
+```