Setup pnpm (#1092)

* chore: setup pnpm * refactor: specify root to resolve path alias * chore: setup pnpm on ci workflows * refactor: remove test-bin in favor of verify-build It adds to verify-build workflow the build-eventcatalog step where it builds the example-default the same way test-bin with docker did. * fix: add build cli step * chore: update README.md to use `pnpm` * Create odd-sloths-collect.md --------- Co-authored-by: David Boyne <[email protected]>
event-catalog · Jan 14, 2025 · 7ffbf6f · 7ffbf6f
1 parent 7a6cd10
commit 7ffbf6f
Show file tree

Hide file tree

Showing 15 changed files with 13,473 additions and 22,276 deletions.
diff --git a/.changeset/odd-sloths-collect.md b/.changeset/odd-sloths-collect.md
@@ -0,0 +1,5 @@
+---
+"@eventcatalog/core": patch
+---
+
+chore(core): setup pnpm on the project
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -13,9 +13,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: pnpm/action-setup@v4
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+      - name: Setup NodeJS
+        uses: actions/setup-node@v4
         with:
-          version: 9
+          node-version: 20.x
+          cache: 'pnpm'
       - name: Installation
         run: pnpm i
       - name: Prettier Code

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -17,18 +17,22 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+
       - name: Use Node.js 20.x
         uses: actions/setup-node@v4
         with:
           node-version: 20.x
+          cache: 'pnpm'
 
-      - name: Install deps and build (with cache)
-        uses: bahmutov/npm-install@v1
+      - name: Install deps
+        run: pnpm i
 
       - name: Create Release Pull Request or Publish to npm
         uses: changesets/action@master
         with:
-          publish: npm run release
+          publish: pnpm run release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
diff --git a/.github/workflows/test-bin.yml b/.github/workflows/test-bin.yml
diff --git a/.github/workflows/verify-build.yml b/.github/workflows/verify-build.yml
@@ -8,21 +8,55 @@ on:
       - main
 
 jobs:
-  build:
-    name: Verify Build
-    timeout-minutes: 30
+  build-cli:
+    name: Build cli
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+      - name: Setup NodeJS
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+          cache: 'pnpm'
+      - name: Installation
+        run: pnpm i
+      - name: Test
+        run: pnpm run test:ci
+      - name: Build cli
+        run: pnpm run build:bin
+      - name: Package
+        run: pnpm pack
+      - name: Rename package artifact
+        run: mv *.tgz package.tgz # Rename to a consistent name
+      - name: Upload package artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: eventcatalog-core-package-artifact
+          path: package.tgz
+
+  build-eventcatalog:
+    name: Build EventCatalog
+    timeout-minutes: 10
+    needs: build-cli
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - name: Setup NodeJS
+        uses: actions/setup-node@v4
         with:
-          node-version: '20.x'
-      - name: Installation
-        run: npm i
-      - name: Test
-        run: npm run test:ci
-      - name: Build
-        run: npm run verify-build:catalog
+          node-version: 20.x
+      - name: Download package artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: eventcatalog-core-package-artifact
+      - name: Install @eventcatalog-core
+        working-directory: examples/default/
+        run: npm install ../../package.tgz
+      - name: Build EventCatalog
+        working-directory: examples/default/
+        run: npx eventcatalog build
diff --git a/Dockerfile b/Dockerfile
diff --git a/README.md b/README.md
@@ -170,8 +170,8 @@ You can find the [contributing guidelines here](https://eventcatalog.dev/docs/co
 ## Running the project locally
 
 1. Clone the repo
-1. Install required dependencies `npm run i`
-1. Run the command `npm run start:catalog`
+1. Install required dependencies `pnpm install`
+1. Run the command `pnpm run start:catalog`
     - This will start the catalog found in `/examples` repo, locally on your machine
 
 [license-badge]: https://img.shields.io/github/license/event-catalog/eventcatalog.svg?color=yellow