chore: Improvements

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

.github/workflows/ci.yml

@@ -6,64 +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
-      - run: |
-          npm install
-      - run: |
-          npm run all
-
-  use:
-    name: Use
-    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
+      - name: Set up pnpm
+        uses: pnpm/action-setup@v3
 
-      - name: Print Node.js and npm version
-        run: |
-          node --version
-          npm --version
-      - uses: ./
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-
-  checkdist:
-    name: Check dist/index.js
-    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
+          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: |
@@ -73,3 +38,8 @@ jobs:
             exit 1
           fi
         id: diff
+
+      - name: Use action
+        uses: ./
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}

.node-version

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

BUILD.md

@@ -1,8 +1,7 @@
 # Building cerbos-setup-action
 
-
 ```
-npm run build && npm run format && npm run lint && npm run package && npm test
+pnpm run format && pnpm run lint && pnpm run build && pnpm test
 ```
 
-`npm run package` will create or overwrite the `dist/index.js` and `dist/index.js` which is the executable part of the GitHub Action.
+`pnpm run build` will create or overwrite the `dist/index.js` and `dist/index.js` which is the executable part of the GitHub Action.

README.md

@@ -21,3 +21,21 @@ steps:
       github_token: <github_token>
       version: latest
 ```
+
+## 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
+    ```

action.yml

@@ -13,4 +13,4 @@ inputs:
 
 runs:
   using: 'node20'
-  main: 'dist/index.js'
+  main: './dist/index.js'