Merge release/1.0.2 into Main

.github/workflows/release-validate.yaml

@@ -0,0 +1,130 @@
+name: Validate Release
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  test-coverage:
+    if: contains(github.head_ref, 'release/') && contains(github.base_ref, 'main')
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: app
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+      - uses: actions/cache@v3
+        with:
+          path: '**/node_modules'
+          key: ${{ runner.os }}-node-${{ steps.node-version.outputs.node-version }}-modules-${{ hashFiles('**/yarn.lock') }}
+      - name: Install dependencies
+        run: yarn install
+      - name: Lint
+        run: yarn lint
+      - name: Format
+        run: yarn format
+      - name: Build
+        run: yarn build
+      - name: Test Coverage
+        run: yarn test:coverage
+      - name: Create badges
+        run: |
+          echo "Update badges readme file"
+          yarn readme:coverage
+      - name: Upload coverage files
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-files
+          path: |
+            app/coverage
+            app/test/badges
+
+  tag:
+    if: contains(github.head_ref, 'release/') && contains(github.base_ref, 'main')
+    needs:
+      - test-coverage
+    runs-on: ubuntu-latest
+    outputs:
+      tag: ${{ steps.tag.outputs.tag }}
+    steps:
+      - name: Extract branch tag
+        id: tag
+        run: |
+          BRANCH=${{ github.head_ref }}
+          TAG="${BRANCH//release\//}"
+          echo $TAG
+          echo "tag=$TAG" >> $GITHUB_OUTPUT
+
+  update-version:
+    if: contains(github.head_ref, 'release/') && contains(github.base_ref, 'main')
+    needs:
+      - tag
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: app
+    env:
+      TAG: ${{ needs.tag.outputs.tag }}
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+      - name: Update version in package.json
+        run: |
+          jq '.version = "${{ env.TAG }}"' package.json > temp.json && mv temp.json package.json
+      - name: Upload updated package.json
+        uses: actions/upload-artifact@v4
+        with:
+          name: updated-package-json
+          path: app/package.json
+
+  commit-push:
+    if: contains(github.head_ref, 'release/') && contains(github.base_ref, 'main')
+    needs:
+      - test-coverage
+      - update-version
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: app
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+      - name: Download coverage files
+        uses: actions/download-artifact@v4
+        with:
+          name: coverage-files
+          path: app
+      - name: Download updated package.json
+        uses: actions/download-artifact@v4
+        with:
+          name: updated-package-json
+          path: app
+      - name: Commit and push changes
+        run: |
+          git config --global user.name "GitHub Actions"
+          git config --global user.email "github-actions@github.com"
+
+          git checkout -B ${{ github.head_ref }} || git checkout -b ${{ github.head_ref }}
+
+          echo "Commit update version to '${{ env.TAG }}' and test coverage badges"
+          git add .
+          git commit -m "chore: update version to '${{ env.TAG }}' and test coverage badges"
+
+          git pull origin ${{ github.head_ref }} --rebase
+
+          git push https://x-access-token:${{ secrets.GH_PAT }}@github.com/${{ github.repository }}.git ${{ github.head_ref }}

.github/workflows/validate.yml → .github/workflows/validate-pr.yml

@@ -1,4 +1,4 @@
-name: Validate
+name: Validate Pull Request
 
 on:
   pull_request:
@@ -8,46 +8,36 @@ on:
     branches:
       - main
       - develop
-      - "release/*"
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
 jobs:
-  validate:
+  validate-pr:
+    if: ${{ (github.event.pull_request.base.ref != 'develop' || github.event.pull_request.head.ref != 'main') && !(contains(github.head_ref, 'release/') && contains(github.base_ref, 'main'))}}
     runs-on: ubuntu-latest
     defaults:
       run:
         working-directory: app
-
-    if: ${{ github.event.pull_request.base.ref != 'develop' || github.event.pull_request.head.ref != 'main' }}
-
     steps:
       - name: Check out code
         uses: actions/checkout@v4
-
       - name: Set up Node
         uses: actions/setup-node@v4
         with:
           node-version: 22
-
       - uses: actions/cache@v3
         with:
           path: '**/node_modules'
-          key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
-
+          key: ${{ runner.os }}-node-${{ steps.node-version.outputs.node-version }}-modules-${{ hashFiles('**/yarn.lock') }}
       - name: Install dependencies
         run: yarn install
-
       - name: Lint
         run: yarn lint
-
       - name: Format
         run: yarn format
-
+      - name: Build
+        run: yarn build
       - name: Test
         run: yarn test
-
-      - name: Build
-        run: yarn build

.husky/pre-commit

@@ -5,7 +5,7 @@ echo "Running pre-commit..."
 
 BRANCH_NAME=$(git rev-parse --abbrev-ref HEAD)
 
-if echo "$BRANCH_NAME" | grep -qE '^(feature|bugfix|release|hotfix|refactor|test)\/[a-z0-9-]+$'; then
+if echo "$BRANCH_NAME" | grep -qE '^(feature|bugfix|release|hotfix|refactor|test)\/.*'; then
   echo "✅ Valid branch name: $BRANCH_NAME"
 else
   echo "🚫 The branch name '$BRANCH_NAME' does not follow the Gitflow standard."
@@ -22,6 +22,15 @@ npm run lint:fix
 echo "Running format fix..."
 npm run format:fix
 
+echo "Running build..."
+npm run build
+
+echo "Running test coverage..."
+npm run test:coverage
+
+echo "Running readme coverage update..."
+npm run readme:coverage
+
 # shellcheck disable=SC2103
 cd ..
 

.husky/pre-push

@@ -2,7 +2,7 @@
 
 BRANCH_NAME=$(git rev-parse --abbrev-ref HEAD)
 
-if echo "$BRANCH_NAME" | grep -qE '^(feature|bugfix|release|hotfix|refactor|test)\/[a-z0-9-]+$'; then
+if echo "$BRANCH_NAME" | grep -qE '^(feature|bugfix|release|hotfix|refactor|test)\/.*'; then
   echo "✅ Valid branch name: $BRANCH_NAME"
 else
   echo "🚫 The branch name '$BRANCH_NAME' does not follow the Gitflow standard."

Makefile

@@ -31,6 +31,10 @@ test:
 test-coverage:
 	docker compose -f yarn.cli.yml run --rm yarn test:coverage
 
+# Run to update readme coverage
+readme-coverage:
+	docker compose -f yarn.cli.yml run --rm yarn readme:coverage
+
 # Updates all project libraries to their latest versions using Yarn,
 # running in a container defined in the yarn.cli.yml file.
 upgrade-lib:

README.md

@@ -4,11 +4,18 @@
   <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
 </p>
 
+
 ### Documentation available in languages
 
 [![en](https://img.shields.io/badge/lang-en-blue.svg)](README.md)
 [![pt-br](https://img.shields.io/badge/lang-pt--br-green.svg)](README.pt-br.md)
 
+### Test Coverage
+
+![Entrypoints](app/test/badges/entrypoints.svg)
+![Core](app/test/badges/core.svg)
+![Infrastructure](app/test/badges/infrastructure.svg)
+![Shared](app/test/badges/shared.svg)
 
 ## Introduction
 

README.pt-br.md

@@ -9,6 +9,15 @@
 [![en](https://img.shields.io/badge/lang-en-blue.svg)](README.md)
 [![pt-br](https://img.shields.io/badge/lang-pt--br-green.svg)](README.pt-br.md)
 
+
+### Cobertura de teste
+
+![Entrypoints](app/test/badges/entrypoints.svg)
+![Core](app/test/badges/core.svg)
+![Infrastructure](app/test/badges/infrastructure.svg)
+![Shared](app/test/badges/shared.svg)
+
+
 ## Introdução
 
 Este projeto foi desenvolvido com fins didáticos, visando explorar e aprofundar o conhecimento no framework **NestJS**.