Merge branch 'master' into next

suites-dev · Dec 31, 2024 · d3e2323 · d3e2323
2 parents a32495e + be8d24b
commit d3e2323
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 32 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 20.x]
+        node-version: [16.x, 18.x, 20.x, 22.x]
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -22,7 +22,7 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v4
         with:
           path: '**/node_modules'
           key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
@@ -47,14 +47,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: '18.x'
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v4
         with:
           path: '**/node_modules'
           key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
@@ -76,14 +76,14 @@ jobs:
         project: ['doubles.jest', 'doubles.sinon', 'core.unit', 'doubles.vitest', 'di.nestjs', 'di.inversify', 'unit']
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: '18.x'
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v4
         with:
           path: '**/node_modules'
           key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}

diff --git a/.github/workflows/publish-packages.yml b/.github/workflows/publish-packages.yml
@@ -53,7 +53,7 @@ jobs:
         if: ${{ matrix.node-version == '16.x' }}
         run: |
           rm -rf packages/doubles/vitest
-          git config --global user.email "ci@suites.dev"
+          git config --global user.email "e2e@suites.dev"
           git config --global user.name "Suites CI"
           git add .
           git commit -am "remove vitest temp"
@@ -87,7 +87,7 @@ jobs:
       - name: Install jq
         run: sudo apt-get install jq
 
-      - name: Remove provenance from publishConfig
+      - name: Remove provenance from package.json files
         run: |
           find packages -name 'package.json' | while read filename; do
             jq 'del(.publishConfig.provenance)' "$filename" > temp.json && mv temp.json "$filename"
@@ -97,20 +97,36 @@ jobs:
         run: |
           git config --global user.email "[email protected]"
           git config --global user.name "Suites e2e"
+
+      - name: Commit Provenance Change
+        run: |
           git add .
           git commit -am "remove provenance"
 
+      - name: Version Packages
+        run: |
+          lerna version --yes \
+          --no-changelog \
+          --allow-branch ${{ inputs.target_branch }} \
+          --no-git-tag-version \
+          --no-push \
+          --force-publish \
+          --no-commit-hooks \
+          --conventional-commits
+
+      - name: Commit Packages Versions
+        run: |
+          git add .
+          git commit -am "bump versions"
+
       - name: Publish Packages
         run: |
           yarn lerna publish from-package --yes \
           --no-git-tag-version \
           --no-push \
-          --no-changelog \
-          --no-commit-hooks \
           --no-git-reset \
           --exact \
-          --force-publish \
-          --dist-tag ci
+          --dist-tag e2e
 
       - name: Setup and Test
         run: |
@@ -122,6 +138,8 @@ jobs:
         run: |
           rm -rf packages
           rm -rf node_modules
+          rm yarn.lock
+          rm package.json
 
       - name: Install Dependencies
         run: |

diff --git a/.github/workflows/release-packages.yml b/.github/workflows/release-packages.yml
@@ -73,7 +73,7 @@ jobs:
 
       - name: Graduate Version
         if: ${{ github.event.inputs.release_type == 'graduate' }}
-        run: npx lerna version graduate --yes
+        run: npx lerna version --conventional-graduate --yes
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 

diff --git a/README.md b/README.md
@@ -4,27 +4,20 @@
 
 <h1 align="center">Suites (formerly Automock)</h1>
 
-Suites is an opinionated, flexible testing meta-framework aim at elevating the software testing experience within
-backend systems. By integrating a wide array of testing tools into a cohesive framework, Suites simplifies the process
-of creating reliable tests, thereby ensuring the development of high-quality software.
+**Suites is a progressive, flexible testing meta-framework aimed at elevating the software testing experience within
+backend systems working with dependency injection (DI) frameworks**.
+
+Suites provides a unified testing experience that combines best practices, industry standards, and a wide range of
+testing tools to help developers create robust, maintainable, and scalable test suites, thereby ensuring the development
+of high-quality software.
 
 [![Codecov Coverage](https://img.shields.io/codecov/c/github/suites-dev/suites/master.svg?style=flat-square)](https://codecov.io/gh/suites-dev/suites)
 [![e2e](https://github.com/suites-dev/suites/actions/workflows/e2e.yml/badge.svg?branch=master)](https://github.com/suites-dev/suites/actions)
 [![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
 [![npm downloads](https://img.shields.io/npm/dm/@suites/unit.svg?label=%40suites%2Funit)](https://npmjs.org/package/@suites/unit "View this project on npm")
 ![npm downloads](https://img.shields.io/npm/dm/@automock/jest.svg?label=%40automock%2Fjest)
 
-[↗️ Visit Documentation](https://suites.dev/docs) &nbsp;&nbsp; [↗️ API Reference](https://suites.dev/api-reference)
-
-## Automock has been rebranded to Suites 🎉
-
-**We are excited to announce that Automock has been rebranded to Suites**!
-
-This change reflects our commitment to providing a comprehensive testing solution that caters to a broader range of
-testing scenarios. The core features and functionality of the framework remain the same, but with a new name and a fresh
-look.
-
-[↗️ Change Log](https://suites.dev/docs/overview/migrating-from-automock)
+[↗️ Visit Documentation](https://suites.dev/docs)
 
 ## Core Features
 
@@ -99,18 +92,18 @@ With the use of the `TestBed`, an instance of the `UserService` class can be cre
 generated for its dependencies. During the test, we have direct access to the automatically generated mock object for
 the `Database` dependency (database).
 
-<p align="right"><a href="https://suites.dev/docs/getting-started/examples">↗️ For more comprehensive examples</a></p>
+<p align="right"><a href="https://suites.dev/docs/overview/quickstart">↗️ Quickstart Guide</a></p>
 
 ## :package: Installation
 
-First, install Suites' core package:
+First, install Suites' unit package:
 
 ```bash
 $ npm i -D @suites/unit
 ```
 
 Then, to fully integrate Suites into your mocking and dependency injection frameworks, install the corresponding
-adapters for your project. For example, to use Suites with Jest and NestJS you would run (alongside the core package):
+adapters for your project. For example, to use Suites with Jest and NestJS you would run (alongside the unit package):
 
 ```bash
 $ npm i -D @suites/doubles.jest @suites/di.nestjs