Conventional Changelog Action

This GitHub Action automates version bumping, git tagging, and changelog generation based on conventional commits.

Note: You must grant contents: write permissions to the GITHUB_TOKEN in your workflow to allow the action to push changes and tags back to the repository.

permissions:
  contents: write

steps:
  - name: Conventional Changelog Action
    uses: TriPSs/conventional-changelog-action@v5
    with:
      github-token: ${{ secrets.github_token }}

If you need to override specific conventional commit settings (like issuePrefixes or issueUrlFormat), provide a path to a configuration file using the config-file-path input. Note that providing this input will cause the preset input to be ignored. You must ensure the required configuration packages are installed in your workflow before the action runs.

'use strict'
const config = require('conventional-changelog-conventionalcommits');

module.exports = config({
    "issuePrefixes": ["TN-"],
    "issueUrlFormat": "https://jira.example.com/browse/{{prefix}}{{id}}"
})

You can use the clean_changelog output to automatically populate the body of a GitHub Release. Use the skipped output to ensure the release step only runs if a new version was actually generated.

- name: Conventional Changelog Action
  id: changelog
  uses: TriPSs/conventional-changelog-action@v5
  with:
    github-token: ${{ secrets.github_token }}
    output-file: "false"

- name: Create Release
  uses: actions/create-release@v1
  if: ${{ steps.changelog.outputs.skipped == 'false' }}
  env:
    GITHUB_TOKEN: ${{ secrets.github_token }}
  with:
    tag_name: ${{ steps.changelog.outputs.tag }}
    release_name: ${{ steps.changelog.outputs.tag }}
    body: ${{ steps.changelog.outputs.clean_changelog }}

A pre-commit hook allows you to run custom logic (like chores or file updates) after the version is determined but before the release commit is created.

Requirements:

• The script must be a CommonJS module.
• It must export a single function: exports.preCommit.
• The function can be async but must not return a value.
• The script must be bundled with all its dependencies.

Props passed to preCommit:

• tag: The next git tag (e.g., v1.12.3).
• version: The next version (e.g., 1.12.3).

interface Props {
  tag: string; // Next tag e.g. v1.12.3
  version: string; // Next version e.g. 1.12.3
}

export function preCommit(props: Props): void {}

These hooks allow you to modify the version or the tag before the changelog is generated. This is useful for manual overrides.

Requirements:

• Must be a CommonJS module.
• Must be bundled with dependencies.

Exported Functions:

• preVersionGeneration(version: string): string: Returns the modified version string.
• preTagGeneration(tag: string): string: Returns the modified tag string.

// Next version e.g. 1.12.3
export function preVersionGeneration(version: string): string {}

// Next tag e.g. v1.12.3
export function preTagGeneration(tag: string): string {}

The action provides the following outputs which can be used in subsequent workflow steps:

• changelog: The full generated changelog for the new version.
• clean_changelog: The generated changelog without the version header (ideal for GitHub Release bodies).
• version: The new version string.
• tag: The name of the generated git tag.
• skipped: A boolean string ('true' or 'false') indicating if the action was skipped (e.g., due to skip-on-empty).

The module exports a function that returns a versioning strategy instance based on the provided file extension. This allows the action to handle different configuration formats (like JSON, YAML, or TOML) or versioning sources (like Git or Mix) using a unified interface.

Supported extensions:

• json -> Json strategy
• yaml or yml -> Yaml strategy
• toml -> Toml strategy
• git -> Git strategy
• exs -> Mix strategy
• properties -> Properties strategy

If the extension is not recognized, the function throws an error.

const getVersioningStrategy = require('./src/version/index.js');

// Example usage:
const strategy = getVersioningStrategy('json', 'package.json');

The action provides several outputs that can be used by subsequent steps in your GitHub Actions workflow (e.g., to create a GitHub Release):

• changelog: The full generated changelog string.
• clean_changelog: The changelog with the first three lines (usually header/metadata) removed.
• version: The new version number (e.g., 1.2.3).
• old_version: The version number before the bump.
• tag: The full git tag (including prefix, e.g., v1.2.3).
• skipped: Set to 'true' if the release was skipped because the changelog was empty and skip-on-empty was enabled.