feat(ci): add examples with corrections

Author: Mikaël Bouchez

.github/workflows/ci.yml

@@ -0,0 +1,96 @@
+name: CI Pipeline
+
+on:
+  push:
+    branches:
+      - examples
+
+jobs:
+  install:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: node_modules
+          key: node-modules-${{ hashFiles('package-lock.json') }}
+          restore-keys: node-modules-
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Upload node_modules as an artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: node-modules
+          path: node_modules
+          retention-days: 1
+
+  test_artifact:
+    runs-on: ubuntu-latest
+    needs: install
+    steps:
+      - name: Download node_modules artifact (2)
+        uses: actions/download-artifact@v4
+        with:
+          name: node-modules
+          path: ./node_modules/
+
+      - name: List node_modules/.bin contents (2)
+        run: ls -la node_modules/.bin
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Biome CLI
+        uses: biomejs/setup-biome@v2
+
+      - name: Run Biome
+        run: biome ci
+
+  typing:
+    runs-on: ubuntu-latest
+    needs: install
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Download node_modules artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: node-modules
+          path: node_modules
+
+      - name: Run type check
+        run: npm run typing-check
+
+  coverage:
+    runs-on: ubuntu-latest
+    needs: install
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Download node_modules artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: node-modules
+          path: node_modules
+
+      - name: Run tests with coverage
+        run: npm run coverage
+
+      - name: "Report Coverage"
+        if: always()
+        uses: davelosert/vitest-coverage-report-action@v2

.gitignore

@@ -51,6 +51,4 @@ node_modules
 !.yarn/sdks
 !.yarn/versions
 .pnp.*
-tsconfig.lib.tsbuildinfo
-
-GITLAB.md
+tsconfig.lib.tsbuildinfo

README.md

@@ -36,7 +36,7 @@ npm install
 git commit --allow-empty -m "Init kata john"
 ```
 
-## Create Your First GitHub Actions Workflow
+## 🚀 Create Your First GitHub Actions Workflow
 
 <details>
 <summary>Expand</summary>
@@ -77,9 +77,6 @@ jobs:
 
       - name: Install dependencies
         run: npm ci
-
-      - name: Install biome
-        run: npm install -D @biomejs/cli-linux-x64
 ```
 
 4. Commit and push your workflow file:
@@ -118,8 +115,6 @@ Once you push your changes, GitHub will automatically trigger the workflow.
 
         3. Install dependencies – Runs npm ci to install dependencies.
 
-        4. Install biome – Installs @biomejs/cli-linux-x64 to avoid issues in GitHub Actions.
-
 </details>
 
 ## 🚀 Using Artifacts and Cache in GitHub Actions
@@ -131,7 +126,7 @@ In GitHub Actions, artifacts and cache serve similar purposes as in GitLab CI:
 
 🔗 Refer to the [GitHub Actions documentation](https://docs.github.com/en/actions/using-workflows/caching-dependencies-and-builds) on caching and artifacts for more details.
 
-### 🏋️ Exercise
+### 📝 Exercise
 
 1. Enhance the `install` job to include artifacts and cache configurations:
 
@@ -213,10 +208,8 @@ By adding a **lint job** in the pipeline, we ensure that all code adheres to bes
 Enhance the workflow by:
 
 1. Creating a new stage called **check**.
-2. Adding a **lint job** that runs `npm run lint`.
-3. Reusing `node_modules/` from the **install** job using GitHub Actions cache & artifacts.
-4. Making **lint** depend on **install**, ensuring dependencies are installed first.
-5. Commit your updated workflow
+2. Adding a **lint job** that runs `biome ci` using the [Setup Biome GitHub Action](https://github.com/marketplace/actions/setup-biome).
+3. Commit your updated workflow
    - Push your changes to trigger the GitHub Actions workflow.
    - Verify that the **lint job** runs successfully in the **Actions** tab. 🚀
 
@@ -226,81 +219,145 @@ Enhance the workflow by:
 <summary>Expand</summary>
 
 ```yaml
-name: CI Pipeline
+lint:
+  runs-on: ubuntu-latest
+  needs: install # Ensures the install job completes first
+  steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Setup Biome CLI
+      uses: biomejs/setup-biome@v2 # The action will look for the version of the @biomejs/biome dependency in the lockfiles of popular package managers such as npm.
+
+    - name: Run Biome
+      run: biome ci # Files won’t be modified, the command is a read-only operation.
+```
 
-on:
-  push:
-    branches:
-      - john
+### 🔍 Explanation
 
-jobs:
-  install:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
+TODO
 
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 22
+</details>
 
-      - name: Cache dependencies
-        uses: actions/cache@v4
-        with:
-          path: node_modules
-          key: node-modules-${{ hashFiles('package-lock.json') }}
-          restore-keys: node-modules-
+## 🚀 Add Typing Check Job in GitHub Actions
 
-      - name: Install dependencies
-        run: npm ci
+Type checking ensures that your TypeScript project is type-safe and free of type-related errors before going to production.
+By using the --noEmit flag, TypeScript verifies the code without generating build files.
 
-      - name: Upload node_modules as an artifact
-        uses: actions/upload-artifact@v4
-        with:
-          name: node-modules
-          path: node_modules
-          retention-days: 1
+### 📝 Exercise
 
-  lint:
-    runs-on: ubuntu-latest
-    needs: install # Ensures the install job completes first
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
+Enhance the workflow by:
 
-      - name: Download node_modules artifact
-        uses: actions/download-artifact@v4
-        with:
-          name: node-modules
-          path: node_modules
+1. Defining a typing job in the check stage.
+2. Running the command: `npm run typing-check` (which should internally run `tsc --noEmit`).
+3. Making the typing job depend on the install job (so `node_modules` is available from artifact).
+4. Commit your changes
 
-      - name: Run linter
-        run: npm run lint
+- Push your code to trigger the GitHub Actions workflow.
+- Confirm that type checking is performed in the Actions tab.
+
+### 🎯 Correction
+
+<details>
+<summary>Expand</summary>
+
+```yaml
+typing:
+  runs-on: ubuntu-latest
+  needs: install
+  steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Download node_modules artifact
+      uses: actions/download-artifact@v4
+      with:
+        name: node-modules
+        path: node_modules
+
+    - name: Run type check
+      run: npm run typing-check
 ```
 
 ### 🔍 Explanation
 
-### **install job**:
+#### `typing job`:
+
+- Depends on the install job using `needs: install`.
+
+- Reuses `node_modules` by downloading the artifact from the previous job.
+
+- Runs `npm run typing-check`, which should call `tsc --noEmit` in your package.json.
+
+#### Why `--noEmit`?
+
+Ensures your TypeScript code compiles without actually creating build output.
+Ideal for CI checks where only validation is needed.
+
+</details>
 
-- Installs dependencies using `npm ci`.
-- Caches `node_modules/` using `actions/cache` for efficiency.
-- Uploads `node_modules/` as an artifact to be used in later jobs.
+## 🚀 Add Coverage Job in GitHub Actions
 
-### **lint job**:
+Code coverage helps measure how much of your codebase is tested by your test suite.
+Generating a coverage report and exposing it as an artifact gives visibility on test quality and helps maintain high standards.
 
-- Declares `needs: install`, ensuring that dependencies are installed first.
-- Downloads `node_modules/` from the artifact saved in the **install** job.
-- Runs `npm run lint` to check code quality.
+### 📝 Exercise
+
+Enhance the workflow by:
+
+1. Adding a new coverage job in the check stage.
+2. Making the coverage job depend on the install job.
+3. Running the command: `npm run coverage` to execute tests and generate a coverage report.
+4. Uploading the coverage report (in Cobertura format, usually coverage/cobertura-coverage.xml) as an artifact.
+5. Adding the coverage summary regex to display the total Statements coverage:
+
+```yaml
+coverage: '/^Statements\s*:\s*([\d\.]+)%/'
+```
+
+6. Commit your changes
+
+- Push your code to trigger the GitHub Actions workflow.
+- Check the coverage percentage and validate that the report is correctly generated and accessible as an artifact.
+
+### 🎯 Correction
+
+<details>
+
+<summary>Expand</summary>
+
+```yaml
+coverage:
+  runs-on: ubuntu-latest
+  needs: install
+  steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Download node_modules artifact
+      uses: actions/download-artifact@v4
+      with:
+        name: node-modules
+        path: node_modules
+
+    - name: Run tests with coverage
+      run: npm run coverage
+
+    - name: Upload coverage report
+      uses: actions/upload-artifact@v4
+      with:
+        name: coverage-report
+        path: coverage/cobertura-coverage.xml
+
+  coverage: '/^Statements\\s*:\\s*([\\d\\.]+)%/' # GitHub reads this regex for coverage summary
+```
 
-### 💡 Why use both **cache** and **artifacts**?
+🔍 Explanation
 
-- **Cache (`actions/cache`)** is shared between workflow runs (persists across multiple commits).
-- **Artifacts (`actions/upload-artifact`)** are job-specific (persist only within the same workflow execution).
+- `npm run coverage` should generate a report in Cobertura format (usually with Jest and `jest --coverage --coverageReporters=cobertura`).
 
-Using both ensures that dependencies are efficiently reused across jobs and across multiple workflow runs.
+- We upload `coverage/cobertura-coverage.xml` as an artifact so it can be downloaded and visualized.
 
-🚀 **This setup ensures faster builds and enforces linting rules before merging any code!**
+The coverage field uses a regex to extract the total statement coverage percentage from the test output (e.g., Statements: 85.45%).
 
 </details>
-Happy automating!