Package Exports

simple-conventional-release
simple-conventional-release/dist/main.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (simple-conventional-release) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

🚀 simple-conventional-release

A simple automated release notes generator for Git repositories using Conventional Commits.

Supports GitHub & GitLab and integrates seamlessly with CI/CD pipelines.

✨ Features

✅ Automated Release Notes – Generates a release note markdown file based on commit messages.
✅ Supports Conventional Commits – Categorizes commits into features, fixes, chores, etc.
✅ GitHub & GitLab Compatible – Generates correct compare links based on the repository host.
✅ Use via JavaScript API or Docker.
✅ Ideal for CI/CD pipelines.

📦 Installation & Usage

🐳 Using Docker

You can use the Docker image to generate release notes in CI/CD pipelines or locally.

Environnement variables are optional, the tool will try to detect the repository path and latest tags automatically but you can override them if needed using the following variables:

Variable	Description	Default
`CUSTOM_REPOSITORY_PATH`	Path to the Git repository	`.`
`CUSTOM_OUTPUT_PATH`	Path to save the release notes	`RELEASE_NOTES.md`
`CUSTOM_FROM_TAG`	Starting tag for the release notes generation	Auto-detected
`CUSTOM_TO_TAG`	Ending tag for the release notes generation	Latest tag
`CUSTOM_WITH_TITLE`	Include the release title in the output	`true`

🏗 Pull the image:

docker pull ghcr.io/animation-digital-network/simple-conventional-release:latest

🔧 Run it locally:

docker run --rm \
  -e CUSTOM_FROM_TAG=v1.0.0 \
  -e CUSTOM_TO_TAG=v1.1.0 \
  -v $(pwd):/app/repository \
  ghcr.io/animation-digital-network/simple-conventional-release

🚀 Example with GitHub Actions:

jobs:
  release-notes:
    name: Generate Release Notes
    runs-on: ubuntu-latest
    env:
      GIT_DEPTH: 0
      CUSTOM_WITH_TITLE: "false"
    container:
      image: ghcr.io/animation-digital-network/simple-conventional-release:latest
    steps:
      - name: Checkout Repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Run simple-conventional-release
        run: |
          echo "Running simple-conventional-release..."

      - name: Upload Release Notes
        uses: actions/upload-artifact@v4
        with:
          name: RELEASE_NOTES
          path: RELEASE_NOTES.md

🚀 Example with Gitlab CI/CD:

release-notes:
  image: ghcr.io/animation-digital-network/simple-conventional-release:latest
  variables:
    GIT_DEPTH: 0
    CUSTOM_WITH_TITLE: "false"
  script:
    - echo "Running simple-conventional-release..."
  artifacts:
    paths:
      - RELEASE_NOTES.md

📜 Using the JavaScript API

You can integrate this tool directly into your JavaScript/TypeScript projects.

📥 Install the package:

npm install simple-conventional-release

🚀 Generate release notes programmatically:

import { generateReleaseNotes } from 'simple-conventional-release';

generateReleaseNotes({
  repositoryPath: '.',
  tags: { from: 'v1.0.0', to: 'v1.1.0' },
  outputPath: 'RELEASE_NOTES.md'
})
  .then((notes) => console.log('Release Notes:\n', notes))
  .catch((error) => console.error('Error:', error));

📜 Conventional Commits Support

This tool supports the Conventional Commits specification to categorize commits automatically:

Type	Description
`build`	Changes that affect the build system or dependencies
`chore`	Routine tasks like refactoring, maintenance, or tooling updates
`ci`	Changes to CI/CD configuration or automation scripts
`docs`	Documentation updates only (e.g., README changes)
`feat`	Introduction of a new feature
`fix`	Bug fixes and patches
`perf`	Performance improvements that do not affect functionality
`refactor`	Code changes that do not add features or fix bugs
`revert`	Reverts a previous commit
`style`	Code style changes (formatting, whitespace, etc.)
`test`	Adding or updating tests

📋 Roadmap

Case Sensitivity – Support for case-insensitive commit types and messages.
Customizable Templates – Allow users to define custom release note templates.
Angular Commit Style – Support for Angular commit message style.
Customizable Categories – Allow users to define custom commit categories.
Full Generation – Generate full release notes with all tags.

📝 License

This project is licensed under the AGPL-3.0 License. See the LICENSE file for details.

🤝 Contributing

Contributions are welcome! Please follow the contribution guidelines.

📬 Issues & Feedback

If you encounter any issues, feel free to report them on our GitHub Issues.