release-suite 0.1.0 → 1.0.1

package/.github/workflows/create-release-pr.yml

@@ -18,12 +18,11 @@ jobs:
   release-pr:
     # Only runs when:
     # - The PR has been merged
-    # - And the branch is NOT release/v/*
+    # - The PR does NOT have the "release" label
     if: >
       github.event.pull_request.merged == true &&
-      !startsWith(github.event.pull_request.head.ref, 'release/v/')
+      !contains(join(github.event.pull_request.labels.*.name, ','), 'release')
     runs-on: ubuntu-latest
-
     steps:
       - uses: actions/checkout@v4
         with:
@@ -48,40 +47,58 @@ jobs:
         run: npm ci
 
       - name: Install release-suite locally (self usage)
-        run: npm install . 
+        run: npm install .
 
       # Compute next version to release
       - name: Compute next version
-        id: semver
+        id: compute
         run: |
-          VERSION=$(rs-compute-version || echo "")
-          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          set +e
+          RESULT=$(node bin/compute-version.js --ci --json)
+          STATUS=$?
+          VERSION=$(echo "$RESULT" | jq -r '.nextVersion // empty')
 
-      - name: Stop if no release needed
-        if: steps.semver.outputs.version == ''
-        run: exit 0
+          echo "$RESULT"
+          echo "status=$STATUS" >> $GITHUB_OUTPUT
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
 
       - name: Bump package.json
-        run: npm version ${{ steps.semver.outputs.version }} --no-git-tag-version
+        if: steps.compute.outputs.status == '0' && steps.compute.outputs.version != ''
+        run: npm version ${{ steps.compute.outputs.version }} --no-git-tag-version
 
       - name: Build
         run: npm run build --if-present
 
       - name: Generate changelog
-        run: rs-generate-changelog
+        if: steps.compute.outputs.status == '0' && steps.compute.outputs.version != ''
+        run: node bin/generate-changelog.js
+
+      - name: Detect dist directory
+        id: dist
+        run: |
+          if [ -d dist ]; then
+            echo "exists=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "exists=false" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Stage dist if exists
+        if: steps.dist.outputs.exists == 'true'
+        run: git add dist
 
       # Automatically create branches, commits, and PRs with peter-evans
       - name: Create Release PR
+        if: steps.compute.outputs.status == '0' && steps.compute.outputs.version != ''
         uses: peter-evans/create-pull-request@v6
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          commit-message: ":bricks: chore(release): prepare version ${{ steps.semver.outputs.version }} [skip ci]"
-          branch: release/v/${{ steps.semver.outputs.version }}
-          title: ":bricks: chore(release): ${{ steps.semver.outputs.version }}"
+          commit-message: ":bricks: chore(release): prepare version ${{ steps.compute.outputs.version }} [skip ci]"
+          branch: release/${{ steps.compute.outputs.version }}
+          title: ":bricks: chore(release): ${{ steps.compute.outputs.version }}"
           body: |
             This PR contains the release artifacts:
 
-            - Updated `package.json` and `package-lock.json` with version ${{ steps.semver.outputs.version }}
+            - Updated `package.json` and `package-lock.json` with version ${{ steps.compute.outputs.version }}
             - Updated `CHANGELOG.md` with latest changes
             - Generated `/dist` directory with build files (if applicable)
 
@@ -91,4 +108,3 @@ jobs:
           add-paths: |
             package.json
             CHANGELOG.md
-            dist/**

package/.github/workflows/publish-on-merge.yml

@@ -1,8 +1,7 @@
 name: Publish Release
 
 on:
-  pull_request:
-    types: [closed]
+  push:
     branches:
       - main
 
@@ -19,13 +18,10 @@ concurrency:
 jobs:
   publish:
     # Only runs when:
-    # - The PR has been merged
-    # - And the branch is release/v/*
+    # - The commit message starts with ":bricks: chore(release):"
     if: >
-      github.event.pull_request.merged == true &&
-      startsWith(github.event.pull_request.head.ref, 'release/v/')
+      startsWith(github.event.head_commit.message, ':bricks: chore(release):')
     runs-on: ubuntu-latest
-
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -44,30 +40,44 @@ jobs:
       - name: Install release-suite locally (self usage)
         run: npm install .
 
-      - name: Build
-        run: npm run build --if-present
-
       - name: Create Git Tag
-        run: rs-create-tag
+        id: tag
+        run: |
+          set +e
+          RESULT=$(node bin/create-tag.js)
+          STATUS=$?
+          TAG=$(echo "$RESULT" | jq -r '.tag // empty')
+
+          echo "$RESULT"
+          echo "status=$STATUS" >> $GITHUB_OUTPUT
+          echo "tag=$TAG" >> $GITHUB_OUTPUT
 
       # Publish to npm using Trusted Publishing (OIDC)
       - name: Publish to npm (Trusted Publishing)
+        if: steps.tag.outputs.status == '0' && steps.tag.outputs.tag != ''
         run: npm publish
 
       # Generate release notes for GitHub Release
       - name: Generate GitHub Release Notes
-        run: rs-generate-release-notes
+        if: steps.tag.outputs.status == '0' && steps.tag.outputs.tag != ''
+        run: node bin/generate-release-notes.js
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       # Create GitHub Release with notes and attach built assets
       - name: Create GitHub Release + Tag
+        if: steps.tag.outputs.status == '0' && steps.tag.outputs.tag != ''
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           VERSION=$(node -p "require('./package.json').version")
 
+          ASSETS=()
+          if [ -d dist ]; then
+            ASSETS=(dist/**)
+          fi
+
           gh release create "$VERSION" \
             --title "$VERSION" \
             --notes-file RELEASE_NOTES.md \
-            ./dist/* || true
+            "${ASSETS[@]}"

package/CHANGELOG.md

@@ -1,5 +1,52 @@
-## 0.1.0
-
-### 🔧 Chore
-
-- Init: project created
+## 1.0.1
+
+### 🐛 Fixes
+
+- Harden changelog generation for squash commits (#13)
+
+### 📚 Docs
+
+- Update ci/cd examples with trigger adjustment
+
+### 🔁 CI
+
+- Adjust trigger in workflow
+
+## 1.0.0
+
+### 💥 Breaking Changes
+
+- Harden computeVersion contract and CLI behavior (#4)
+
+### 🐛 Fixes
+
+- Normalize path resolution for all CLI scripts (#2)
+
+### 🔧 Chore
+
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+
+### 🔁 CI
+
+- Harden local script execution and dist resolution (#10)
+- Binary resolution (#3)
+
+## 0.1.0
+
+### 🔧 Chore
+
+- Init: project created

package/README.md

@@ -1,183 +1,195 @@
-# 🎉 Release Suite
-
-Semantic versioning tools for Git-based projects, providing automated version computation, changelog generation and release notes creation.
-
-## 🚀 Features
-
-- Automatic version bump based on commit messages
-- Conventional commit parsing (custom prefixes supported)
-- Auto-generated `CHANGELOG.md`
-- Auto-generated `RELEASE_NOTES.md` using GitHub CLI (gh)
-- Local preview mode (`CHANGELOG.preview.md`, `RELEASE_NOTES.preview.md`)
-- CI/CD ready for GitHub Actions
-- No commit rules enforced on the main project
-- Trusted Publishing (OIDC) — no npm tokens required
-
-## ⚙️ Installation
-
-```bash
-npm install release-suite --save-dev
-```
-
-## 🖥️ CLI Commands
-
-| Command                     | Description                                               |
-| --------------------------- | --------------------------------------------------------- |
-| `rs-compute-version`        | Computes next semantic version based on git commits       |
-| `rs-generate-changelog`     | Generates `CHANGELOG.md`                                  |
-| `rs-generate-release-notes` | Generates `RELEASE_NOTES.md` using GitHub PRs             |
-| `rs-preview`                | Generates preview changelog & release notes               |
-| `rs-create-tag`             | Create and push a git tag based on `package.json` version |
-
-## 🧠 Usage
-
-Add to your project's `package.json`:
-
-```json
-{
-  "scripts": {
-    "version:compute": "rs-compute-version",
-    "changelog": "rs-generate-changelog",
-    "release:notes": "rs-generate-release-notes",
-    "preview": "rs-preview create",
-    "preview:clear": "rs-preview remove",
-    "create-tag": "rs-create-tag",
-    "create-tag:compute": "rs-create-tag --compute",
-    "create-tag:dry": "rs-create-tag --dry-run"
-  }
-}
-```
-
-## 🤖 CI/CD Usage (GitHub Actions)
-
-This project is designed to be used in automated pipelines.
-
-Typical flow:
-
-1. Create a Release PR (compute version, changelog, build)
-2. Review and merge the Release PR into `main`
-3. Publish the release (tag, npm, GitHub Release)
-
-Example workflows:
-- create-release-pr.yml
-- publish-on-merge.yml
-
-## 🔁 Release Flow
-
-This project follows a **two-step release strategy** designed for safety,
-automation and reusability.
-
-### 1️⃣ Prepare Release (Create Release PR)
-
-Triggered when:
-
-- A PR is merged into `main`
-
-Actions:
-
-- Computes next semantic version
-- Updates `package.json`
-- Generates `CHANGELOG.md`
-- Builds the project (if applicable)
-- Opens a **Release PR** (`release/v/x.y.z`)
-
-### 2️⃣ Publish Release
-
-Triggered when:
-
-- A Release PR (`release/v/*`) is merged into `main`
-
-Actions:
-
-- Creates a Git tag
-- Publishes to npm using **Trusted Publishing (OIDC)**
-- Generates GitHub Release Notes
-- Uploads build artifacts (`dist/**`)
-
----
-
-### 📊 Flow Diagram
-
-```mermaid
-flowchart TD
-    A[Feature / Fix PR] -->|Merge| B[main]
-    B -->|create-release-pr.yml| C[Create Release PR]
-    C -->|release/v/x.y.z| D[Review & Merge]
-    D -->|publish-on-merge.yml| E[Publish Release]
-    E --> F[npm Publish]
-    E --> G[GitHub Release]
-```
-
-✔️ Fully automated releases  
-✔️ No npm tokens or secrets required (OIDC)  
-✔️ No release loops  
-✔️ Safe for concurrent merges  
-✔️ Reusable in any project 
-
-## 📦 Publishing to npm (Trusted Publishing)
-
-This project uses **npm [Trusted Publishing](https://docs.npmjs.com/trusted-publishers) with GitHub Actions (OIDC)**.
-
-- No npm tokens or secrets are required
-- Publishing is handled entirely by GitHub Actions
-- Triggered automatically when a Release PR is merged into `main`
-
-## 🔍 Preview Mode
-
-Generate preview files without touching your real changelog:
-
-```bash
-npm run preview
-```
-
-Remove previews:
-
-```bash
-npm run preview:clear
-```
-
-## 🛠 Development (Maintainers)
-
-When working inside the `release-suite` repository itself, the CLI binaries
-are **not available via npm or npx**, since they are not installed as a dependency.
-
-In this case, run the scripts directly with Node.js:
-
-```bash
-node bin/compute-version.js
-node bin/generate-changelog.js
-node bin/generate-release-notes.js
-node bin/preview.js create
-node bin/create-tag.js
-```
-
-To test the CLI as a real consumer, you can use:
-
-```bash
-npm link
-# or
-npm install ../release-suite
-```
-
-## 📄 License
-
-This project is licensed under the [MIT License](./LICENSE).
-
----
-
-## ✨ Author
-
-<table>
-  <tr>
-    <td align="center">
-      <a href="https://jonasmzsouza.github.io/">
-         <img style="border-radius: 50%;" src="https://avatars.githubusercontent.com/u/61324433?v=4" width="100px;" alt=""/>
-         <br />
-         <sub><b>Jonas Souza</b></sub>
-      </a>
-    </td>
-  </tr>
-</table>
- 
-💼 [LinkedIn](https://linkedin.com/in/jonasmzsouza)
-💻 [GitHub](https://github.com/jonasmzsouza)
+# 🎉 Release Suite
+
+Semantic versioning tools for Git-based projects, providing automated version computation, changelog generation and release notes creation.
+
+> Designed for safe, predictable and fully automated releases in GitHub Actions.
+
+## 🚀 Features
+
+- Automatic version bump based on commit messages
+- Conventional commit parsing (custom prefixes supported)
+- Auto-generated `CHANGELOG.md`
+- Auto-generated `RELEASE_NOTES.md` using GitHub CLI (gh)
+- Local preview mode (`CHANGELOG.preview.md`, `RELEASE_NOTES.preview.md`)
+- CI/CD ready for GitHub Actions
+- No commit rules enforced on the main project
+- Trusted Publishing (OIDC) — no npm tokens required
+
+## ⚡ Quick Start
+
+```bash
+npm install release-suite --save-dev
+```
+
+Add to your project's `package.json`:
+
+```json
+{
+  "scripts": {
+    "preview": "rs-preview create",
+    "preview:clean": "rs-preview remove",
+    "compute-version": "rs-compute-version",
+    "compute-version:ci": "rs-compute-version --ci --json",
+    "compute-version:json": "rs-compute-version --json",
+    "changelog": "rs-generate-changelog",
+    "release-notes": "rs-generate-release-notes"
+  }
+}
+```
+
+Generate preview files without touching your real changelog:
+
+```bash
+npm run preview
+```
+
+Remove previews:
+
+```bash
+npm run preview:clear
+```
+
+## 🖥️ CLI Commands
+
+| Command                     | Description                                               |
+| --------------------------- | --------------------------------------------------------- |
+| `rs-compute-version`        | Computes next semantic version based on git commits       |
+| `rs-generate-changelog`     | Generates `CHANGELOG.md`                                  |
+| `rs-generate-release-notes` | Generates `RELEASE_NOTES.md` using GitHub PRs             |
+| `rs-preview`                | Generates preview changelog & release notes               |
+| `rs-create-tag`             | Create and push a git tag based on `package.json` version |
+
+Each command follows a strict and predictable CLI contract (exit codes, stdout, JSON mode).
+
+> 💡 **Note about execution**
+>
+> - When using these commands via `npm run`, they can be referenced directly (`rs-*`).
+> - In CI/CD environments (e.g. GitHub Actions), always invoke them using `npx`
+>   (e.g. `npx rs-generate-changelog`) to ensure proper binary resolution.
+
+## 🔁 Release Flow
+
+This project follows a **two-step release strategy** designed for safety,
+automation and reusability.
+
+### 1️⃣ Prepare Release (Create Release PR)
+
+Triggered when:
+
+- A PR is merged into `main`
+
+Actions:
+
+- Computes next semantic version
+- Updates `package.json`
+- Generates `CHANGELOG.md`
+- Builds the project (if applicable)
+- Opens a **Release PR** (`release/x.y.z`)
+
+### 2️⃣ Publish Release
+
+Triggered when:
+
+- A Release PR (`release/x.y.z`) with `release` label is merged into `main`
+
+Actions:
+
+- Creates a Git tag
+- Publishes to npm using **Trusted Publishing (OIDC)**
+- Generates GitHub Release Notes
+- Uploads build artifacts (`dist/**`)
+
+---
+
+### 📊 Flow Diagram
+
+```mermaid
+flowchart TD
+    A[Feature / Fix PR] -->|Merge| B[main]
+    B -->|create-release-pr.yml| C[Create Release PR]
+    C -->|release/x.y.z| D[Review & Merge]
+    D -->|publish-on-merge.yml| E[Publish Release]
+    E --> F[npm Publish]
+    E --> G[GitHub Release]
+```
+
+✔️ Fully automated releases  
+✔️ No npm tokens or secrets required (OIDC)  
+✔️ No release loops  
+✔️ Safe for concurrent merges  
+✔️ Reusable in any project
+
+## 🤖 CI/CD Usage (GitHub Actions)
+
+> ℹ️ In CI/CD environments, always use `npx` when invoking `rs-*` commands.
+
+This project is designed to be used in automated pipelines.
+
+Typical flow:
+
+1. Create a Release PR (compute version, changelog, build)
+2. Review and merge the Release PR into `main`
+3. Publish the release (tag, npm, GitHub Release)
+
+👉 See full examples in [`docs/ci.md`](./docs/ci.md)
+
+## 📦 Publishing to npm (Trusted Publishing)
+
+This project uses **npm [Trusted Publishing](https://docs.npmjs.com/trusted-publishers) with GitHub Actions (OIDC)**.
+
+- No npm tokens or secrets are required
+- Publishing is handled entirely by GitHub Actions
+- Triggered automatically when a Release PR is merged into `main`
+
+## 🧩 Programmatic API
+
+Release Suite also exposes a programmatic API for advanced use cases
+(integration tests, custom tooling, orchestration).
+
+👉 See full API documentation in [`docs/api.md`](./docs/api.md)
+
+## 🛠 Development (Maintainers)
+
+When working inside the `release-suite` repository itself, the CLI binaries
+are **not available via npm or npx**, since they are not installed as a dependency.
+
+In this case, run the scripts directly with Node.js:
+
+```bash
+node bin/compute-version.js
+node bin/generate-changelog.js
+node bin/generate-release-notes.js
+node bin/preview.js create
+node bin/create-tag.js
+```
+
+To test the CLI as a real consumer, you can use:
+
+```bash
+npm link
+# or
+npm install ../release-suite
+```
+
+## 📄 License
+
+This project is licensed under the [MIT License](./LICENSE).
+
+---
+
+## ✨ Author
+
+<table>
+  <tr>
+    <td align="center">
+      <a href="https://jonasmzsouza.github.io/">
+         <img style="border-radius: 50%;" src="https://avatars.githubusercontent.com/u/61324433?v=4" width="100px;" alt=""/>
+         <br />
+         <sub><b>Jonas Souza</b></sub>
+      </a>
+    </td>
+  </tr>
+</table>
+ 
+💼 [LinkedIn](https://linkedin.com/in/jonasmzsouza)
+💻 [GitHub](https://github.com/jonasmzsouza)