[ticket-id] type(scope): message header format does not trigger any release

[SalahAdDin]

The above mentioned commit format is not generating a release version for us:
6_Release.txt

What is the issue with the format? We don't have any release from the beginning, could it be the problem?

It is not even squashing a branch where merging a PR, it is the raw PR itself,

Our configuration is as follows:

{
  "branches": "main",
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    [
      "@semantic-release/changelog",
      {
        "changelogFile": "CHANGELOG.md",
        "changelogTitle": "# Semantic Versioning Changelog"
      }
    ],
    [
      "@semantic-release/git",
      {
        "assets": ["package.json", "CHANGELOG.md"],
        "message": "chore(release): ${nextRelease.version} [skip ci].\n\n${nextRelease.notes}"
      }
    ],
    "@semantic-release/github"
  ]
}

How can we solve this?

[travi]

Including the ticket id at the beginning of the commit message is not valid according to the default commit convention

[SalahAdDin]

@travi is there any documentation about how to do it?

[travi]

https://semantic-release.gitbook.io/semantic-release/#commit-message-format

[SalahAdDin]

@travi Ok, I'm building the following configuration but it still does not work:

[
      "@semantic-release/commit-analyzer",
      {
        "preset": "conventionalcommits",
        "presetConfig": {
          "issuePrefixes": ["TGW-"],
          "issueUrlFormat": "https://github.com/trt-digital/global-webFE/issues/{{prefix}}{{id}}"
        },
        "releaseRules": [
          { "breaking": true, "release": "major" },
          { "revert": true, "release": "patch" },
          { "type": "build", "release": "patch" },
          { "type": "docs", "release": "patch" },
          { "type": "feat", "release": "minor" },
          { "type": "fix", "release": "patch" },
          { "type": "perf", "release": "patch" },
          { "type": "refactor", "release": "patch" }
        ],
        "parserOptions": {
          "headerPattern": "/^(?:[([A-z]*-d+)]s)?(w*)(?:((.*)))?!?:s(.*)$/",
          "headerCorrespondence": ["ticket", "type", "scope", "subject"]
        }
      }
    ],

Our commintlint is as follows:

import { LintOptions, QualifiedRules, UserConfig } from "@commitlint/types";

declare module "@commitlint/types" {
  interface Commit {
    ticket: string | null;
  }
}

const types = [
  "build",
  "chore",
  "ci",
  "docs",
  "feat",
  "fix",
  "perf",
  "refactor",
  "revert",
  "style",
  "test",
];

export const parserPreset: LintOptions = {
  parserOpts: {
    // https://regex101.com/r/7znOoR/1
    headerPattern: /^(?:\[([A-z]*-\d+)]\s)?(\w*)(?:\((.*)\))?!?:\s(.*)$/,
    headerCorrespondence: ["ticket", "type", "scope", "subject"],
  },
};

export const rules: QualifiedRules = {
  "scope-case": [2, "always", "lower-case"],
  "type-enum": [2, "always", types],
  "body-max-line-length": [2, "always", 250],
  "header-max-length": [2, "always", 150],
};

const Configuration: UserConfig = {
  extends: ["@commitlint/config-conventional"],
  // TODO:  update with documentation link
  helpUrl: "commit-convention",
  parserPreset,
  rules,
};

export default Configuration;

[SalahAdDin]

From our commit lint we produced the following semantic release configuration:

/**
 * @type {import('semantic-release').GlobalConfig}
 */

const parserOpts = {
  headerPattern: /^(?:\[([A-z]*-\d+)]\s)?(\w*)(?:\((.*)\))?!?:\s(.*)$/,
  headerCorrespondence: ["ticket", "type", "scope", "subject"],
};

const presetConfig = {
  issuePrefixes: ["TGW-"],
  issueUrlFormat: "{{host}}/{{owner}}/{{repository}}/issues/{{id}}",
};

module.exports = {
  branches: ["main", "next"],
  plugins: [
    [
      "@semantic-release/commit-analyzer",
      {
        preset: "conventionalcommits",
        presetConfig,
        releaseRules: [
          { breaking: true, release: "major" },
          { revert: true, release: "patch" },
          { type: "build", release: "patch" },
          { type: "docs", release: "patch" },
          { type: "feat", release: "minor" },
          { type: "fix", release: "patch" },
          { type: "perf", release: "patch" },
          { type: "refactor", release: "patch" },
        ],
        parserOpts,
      },
    ],
    [
      "@semantic-release/release-notes-generator",
      {
        preset: "conventionalcommits",
        presetConfig: {
          ...presetConfig,
          types: [
            { type: "build", section: "Build", hidden: false },
            { type: "chore", section: "Chores", hidden: true },
            { type: "ci", section: "CI/CD", hidden: false },
            { type: "docs", section: "Docs", hidden: false },
            { type: "feat", section: "Features", hidden: false },
            { type: "fix", section: "Bug Fixes", hidden: false },
            { type: "perf", section: "Performance", hidden: false },
            { type: "refactor", section: "Refactor", hidden: false },
            { type: "style", section: "Code Style", hidden: false },
            { type: "test", section: "Tests", hidden: false },
          ],
        },
        parserOpts,
      },
    ],
    [
      "@semantic-release/changelog",
      {
        changelogFile: "CHANGELOG.md",
        changelogTitle: "# Releases",
      },
    ],
    [
      "@semantic-release/git",
      {
        assets: ["package.json", "CHANGELOG.md"],
        message:
          "[TGW-0] chore(release): ${nextRelease.version} ${nextRelease.type} [skip ci]",
      },
    ],
    "@semantic-release/github",
  ],
};