semantic-release-pr-fix

A wrapper for commit-analyzer and release-notes-generator that handles Azure DevOps PR merge commits.

Problem

When using semantic-release with Azure DevOps repositories, merged PRs have a prefix added to the commit message: Merged PR 1234: original message. This prevents semantic-release from properly detecting release types because it expects semantic commit messages to start with prefixes like feat:, fix:, etc.

This wrapper strips the Azure DevOps PR prefix from commit messages before passing them to the commit-analyzer, allowing semantic-release to properly parse your commits.

Install

1npm install -D semantic-release-pr-fix

Usage

In your .releaserc.json or release.config.js file:

1{
2  "plugins": [
3    ["semantic-release-pr-fix", {
4      "commitAnalyzerConfig": {
5        "preset": "angular",
6        "parserOpts": {
7          "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]
8        }
9      },
10      "notesGeneratorConfig": {
11        "preset": "angular",
12        "writerOpts": {
13          "commitsSort": ["subject", "scope"]
14        }
15      }
16    }],
17    "@semantic-release/npm",
18    "@semantic-release/github"
19  ]
20}

This plugin replaces both @semantic-release/commit-analyzer and @semantic-release/release-notes-generator by wrapping them with Azure DevOps PR merge commit compatibility.

Configuration

The plugin supports the following configuration options:

Option	Description
commitAnalyzerConfig	Configuration object passed directly to @semantic-release/commit-analyzer. See commit-analyzer documentation for available options.
notesGeneratorConfig	Configuration object passed directly to @semantic-release/release-notes-generator. See release-notes-generator documentation for available options. Set to false to disable release notes generation.

Disabling Release Notes Generation

If you want to use a different release notes generator plugin, you can disable the built-in notes generation:

1{
2  "plugins": [
3    ["semantic-release-pr-fix", {
4      "commitAnalyzerConfig": {
5        "preset": "angular"
6      },
7      "notesGeneratorConfig": false
8    }],
9    "@semantic-release/release-notes-generator",
10    "@semantic-release/npm"
11  ]
12}

How it works

The plugin processes each commit message and removes the Azure DevOps PR merge prefix (Merged PR xxxx:) before passing the commits to the standard semantic-release plugins. This allows your semantic commit messages to be properly recognized even when they're part of merged PRs in Azure DevOps.

It handles both version determination (via commit-analyzer) and release notes generation (via release-notes-generator), ensuring consistent processing of PR merge commits throughout the semantic-release pipeline.