ci: New CI/CD process

Author: klerick

.github/actions/action.yml

@@ -1,34 +1,36 @@
-name: 'My composite action'
-description: 'Checks out the repository and install'
+name: Main action for Node.js
+description: Setup Node.js
+
+inputs:
+  node-version:
+    description: Node.js version
+    required: false
+    default: 20.x
+
 runs:
-  using: 'composite'
+  using: composite
   steps:
-    - name: Setup Node.js
-      uses: actions/setup-node@v4
+    - name: Use Node.js ${{ inputs.node-version }}
+      uses: actions/setup-node@v3
       with:
-        node-version: 20
+        node-version: ${{ inputs.node-version }}
         registry-url: 'https://registry.npmjs.org'
-    - name: Restore cached npm dependencies
-      id: cache-dependencies-restore
-      uses: actions/cache/restore@v4
+        cache: npm
+
+    - name: Get npm cache directory
+      id: npm-cache-dir
+      shell: pwsh
+      run: echo "dir=$(npm config get cache)" >> ${env:GITHUB_OUTPUT}
+
+    - name: Cache NPM dependencies
+      uses: actions/cache@v4
+      id: npm-cache # use this to check for `cache-hit` ==> if: steps.npm-cache.outputs.cache-hit != 'true'
       with:
-        path: |
-          node_modules
-          ~/.cache/Cypress # needed for the Cypress binary
-        key: ${{ runner.os }}-npm-dependencies-${{ hashFiles('package-lock.json') }}
-    - name: Npm install
-      if: steps.cache-dependencies-restore.outputs.cache-hit != 'true'
-      run: npm ci
+        path: ${{ steps.npm-cache-dir.outputs.dir }}
+        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-node-
+
+    - name: Install Dependencies
       shell: bash
-    - name: Cache npm dependencies
-      id: cache-dependencies-save
-      uses: actions/cache/save@v4
-      with:
-        path: |
-          node_modules
-          ~/.cache/Cypress # needed for the Cypress binary
-        key: ${{ steps.cache-dependencies-restore.outputs.cache-primary-key }}
-    - name: Derive appropriate SHAs for base and head for `nx affected` commands
-      uses: nrwl/nx-set-shas@v4
-      with:
-        main-branch-name: "master"
+      run: npm ci

.github/workflows/build.yml

@@ -0,0 +1,26 @@
+name: ⚙️ Build
+
+on:
+  workflow_call:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      NX_CLOUD_ACCESS_TOKEN: ${{ secrets.NX_CLOUD_ACCESS_TOKEN }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - run: git branch --track main origin/master
+      - name: Derive appropriate SHAs for base and head for `nx affected` commands
+        uses: nrwl/nx-set-shas@v4
+        with:
+          main-branch-name: "master"
+
+      - name: Setup Node.js
+        uses: ./.github/actions
+
+      - name: Build Libraries
+        run: npx nx affected --target=build --parallel=3  --exclude='*,!tag:type:publish'

.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: ⚙️ E2E Test
+on:
+  workflow_call:
+
+jobs:
+  e2e-test:
+    runs-on: ubuntu-latest
+    env:
+      NX_CLOUD_ACCESS_TOKEN: ${{ secrets.NX_CLOUD_ACCESS_TOKEN }}
+    services:
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: json-api-db
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: ./.github/actions
+      - run: npm run typeorm migration:run
+      - run: npm run seed:run
+      - run: npx nx run json-api-server-e2e:e2e --parallel=1
+      - run: npx nx run json-api-server-e2e:e2e-micro --parallel=1

.github/workflows/e2e-test.yaml

@@ -0,0 +1,12 @@
+name: 📝 PR Checks
+
+on: [pull_request]
+
+jobs:
+  test:
+    uses: ./.github/workflows/test.yml
+  e2e-test:
+    uses: ./.github/workflows/e2e-test.yaml
+  build:
+    needs: [test, e2e-test]
+    uses: ./.github/workflows/build.yml

.github/workflows/pr.yml

@@ -0,0 +1,25 @@
+name: ⚙️ Test
+
+on:
+  workflow_call:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    env:
+      NX_CLOUD_ACCESS_TOKEN: ${{ secrets.NX_CLOUD_ACCESS_TOKEN }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: ./.github/actions
+
+      - name: Derive appropriate SHAs for base and head for `nx affected` commands
+        uses: nrwl/nx-set-shas@v4
+        with:
+          main-branch-name: "master"
+
+      - name: Test
+        run: npx nx affected --target=test --parallel=3 --passWithNoTests --exclude='*,!tag:type:publish'

.github/workflows/test.yml

@@ -33,16 +33,14 @@ describe('post-relationshipa', () => {
   let comments: Collection<Comments>;
   let userObject: Users;
   let newUser: Users;
-  beforeAll(async () => {
+
+  beforeEach(async () => {
     dbName = dbRandomName();
     const moduleUsers = await getModuleForPgLite(Users, dbName);
     microOrmServiceUser = moduleUsers.get<MicroOrmService<Users>>(ORM_SERVICE);
     mikroORMUsers = moduleUsers.get(MikroORM);
     em = moduleUsers.get(CURRENT_ENTITY_MANAGER_TOKEN);
     await pullData(em, 10);
-  });
-
-  beforeEach(async () => {
     userObject = (await microOrmServiceUser.microOrmUtilService
       .queryBuilder()
       .limit(1)
@@ -77,14 +75,11 @@ describe('post-relationshipa', () => {
   });
 
   afterEach(() => {
+    mikroORMUsers.close(true);
     jest.clearAllMocks();
     jest.restoreAllMocks();
   });
 
-  afterAll(() => {
-    mikroORMUsers.close(true);
-  });
-
   it('should be ok', async () => {
     const roles1 = faker.helpers.arrayElement(roles);
     const roles2 = faker.helpers.arrayElement(roles);

libs/json-api/json-api-nestjs-microorm/src/lib/orm-methods/post-relationship/post-relationship.spec.ts

@@ -15,7 +15,8 @@
       "@klerick/json-api-nestjs": [
         "libs/json-api/json-api-nestjs/src/index.ts"
       ]
-    }
+    },
+    "allowJs": true
   },
   "include": [
     "jest.config.ts",

libs/json-api/json-api-nestjs-microorm/tsconfig.spec.json

@@ -9,7 +9,8 @@
       "@klerick/json-api-nestjs-shared": [
         "libs/json-api/json-api-nestjs-shared/src/index.ts"
       ]
-    }
+    },
+    "allowJs": true
   },
   "include": [
     "jest.config.ts",

libs/json-api/json-api-nestjs-sdk/tsconfig.spec.json

@@ -11,7 +11,7 @@
       }
     }
   },
-  "tags": [],
+  "tags": ["type:lib", "lib:json-api-nestjs", "lib:json-api-nestjs-shared", "type:publish"],
   "targets": {
     "build-cjs": {
       "executor": "@nx/js:tsc",

libs/json-api/json-api-nestjs-shared/project.json

@@ -12,7 +12,8 @@
       "@klerick/json-api-nestjs": [
         "libs/json-api/json-api-nestjs/src/index.ts"
       ]
-    }
+    },
+    "allowJs": true
   },
   "include": [
     "jest.config.ts",

libs/json-api/json-api-nestjs-typeorm/tsconfig.spec.json

@@ -9,7 +9,8 @@
       "@klerick/json-api-nestjs-shared": [
         "libs/json-api/json-api-nestjs-shared/src/index.ts"
       ]
-    }
+    },
+    "allowJs": true
   },
   "include": [
     "jest.config.ts",

libs/json-api/json-api-nestjs/tsconfig.spec.json

@@ -105,5 +105,5 @@
       }
     }
   },
-  "tags": []
+  "tags": ["type:lib", "lib:nestjs-json-rpc", "lib:nestjs-json-rpc-sdk", "type:publish"]
 }

libs/json-rpc/nestjs-json-rpc-sdk/project.json

@@ -50,5 +50,5 @@
       }
     }
   },
-  "tags": []
+  "tags": ["type:lib", "lib:nestjs-json-rpc", "lib:nestjs-json-rpc", "type:publish"]
 }