semantic-release / issue-parser

Parser for Github, GitLab and Bitbucket issues actions, references and mentions

📦🚀 semantic-release

Fully automated version management and package publishing

semantic-release automates the whole package release workflow including: determining the next version number, generating the release notes, and publishing the package.

This removes the immediate connection between human emotions and version numbers, strictly following the Semantic Versioning specification and communicating the impact of changes to consumers.

Trust us, this will change your workflow for the better. – egghead.io

Highlights

• Fully automated release
• Enforce Semantic Versioning specification
• New features and fixes are immediately available to users
• Notify maintainers and users of new releases
• Use formalized commit message convention to document changes in the codebase
• Publish on different distribution channels (such as npm dist-tags) based on git merges
• Integrate with your continuous integration workflow
• Avoid potential errors associated with manual releases
• Support any package managers and languages via plugins
• Simple and reusable configuration via shareable configurations
• Support for npm package provenance that promotes increased supply-chain security via signed attestations on GitHub Actions

How does it work?

Commit message format

semantic-release uses the commit messages to determine the consumer impact of changes in the codebase. Following formalized conventions for commit messages, semantic-release automatically determines the next semantic version number, generates a changelog and publishes the release.

By default, semantic-release uses Angular Commit Message Conventions. The commit message format can be changed with the preset or config options of the @semantic-release/commit-analyzer and @semantic-release/release-notes-generator plugins.

Tools such as commitizen or commitlint can be used to help contributors and enforce valid commit messages.

The table below shows which commit message gets you which release type when semantic-release runs (using the default configuration):

Commit message	Release type
fix(pencil): stop graphite breaking when too much pressure applied	Patch Fix Release
feat(pencil): add 'graphiteWidth' option	Minor Feature Release
perf(pencil): remove graphiteWidth option BREAKING CHANGE: The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reasons.	Major Breaking Release (Note that the BREAKING CHANGE: token must be in the footer of the commit)

Automation with CI

semantic-release is meant to be executed on the CI environment after every successful build on the release branch. This way no human is directly involved in the release process and the releases are guaranteed to be unromantic and unsentimental.

Triggering a release

For each new commit added to one of the release branches (for example: master, main, next, beta), with git push or by merging a pull request or merging from another branch, a CI build is triggered and runs the semantic-release command to make a release if there are codebase changes since the last release that affect the package functionalities.

semantic-release offers various ways to control the timing, the content and the audience of published releases. See example workflows in the following recipes:

• Using distribution channels
• Maintenance releases
• Pre-releases

Release steps

After running the tests, the command semantic-release will execute the following steps:

Step	Description
Verify Conditions	Verify all the conditions to proceed with the release.
Get last release	Obtain the commit corresponding to the last release by analyzing Git tags.
Analyze commits	Determine the type of release based on the commits added since the last release.
Verify release	Verify the release conformity.
Generate notes	Generate release notes for the commits added since the last release.
Create Git tag	Create a Git tag corresponding to the new release version.
Prepare	Prepare the release.
Publish	Publish the release.
Notify	Notify of new releases or errors.

Requirements

In order to use semantic-release you need:

• To host your code in a Git repository
• Use a Continuous Integration service that allows you to securely set up credentials
• A Git CLI version that meets our version requirement installed in your Continuous Integration environment
• A Node.js version that meets our version requirement installed in your Continuous Integration environment

Documentation

• Usage
  • Getting started
  • Installation
  • CI Configuration
  • Configuration
  • Plugins
  • Workflow configuration
  • Shareable configurations
• Extending
  • Plugins
  • Shareable configuration
• Recipes
  • CI configurations
  • Git hosted services
  • Release workflow
• Developer guide
  • JavaScript API
  • Plugins development
  • Shareable configuration development
• Support
  • Resources
  • Frequently Asked Questions
  • Troubleshooting
  • Node version requirement
  • Node Support Policy

Get help

• GitHub Discussions
• Stack Overflow
• Twitter

Badge

Let people know that your package is published using semantic-release and which commit-convention is followed by including this badge in your readme.

[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

Team

Gregor Martynus	Pierre Vanduynslager	Matt Travi

Alumni

Stephan Bönnemann	Rolf Erik Lekang	Johannes Jörg Schmidt	Finn Pauls	Christoph Witzko

issue-parser's Issues

An in-range update of semantic-release is breaking the build 🚨

Version 15.9.7 of semantic-release was just published.

Branch	Build failing 🚨
Dependency	semantic-release
Current Version	15.9.6
Type	devDependency

This version is covered by your current version range and after updating it in your project the build failed.

semantic-release is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ continuous-integration/travis-ci/push: The Travis CI build could not complete due to an error (Details).

---

Release Notes

v15.9.7

15.9.7 (2018-08-10)

Reverts

• "fix: do not convert ssh repositoryUrl to https" (93377eb)

Commits

The new version differs by 1 commits.

• 93377eb revert: "fix: do not convert ssh repositoryUrl to https"

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update dependency xo to v0.39.1
• chore(deps): lock file maintenance

Detected dependencies

github-actions

.github/workflows/release.yml

• actions/checkout v4.1.5@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b
• actions/setup-node v4.0.2@60edb5dd545a775178f52524783378180af0d1f8

.github/workflows/test.yml

• actions/checkout v4.1.5@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b
• actions/setup-node v4.0.2@60edb5dd545a775178f52524783378180af0d1f8
• actions/checkout v4.1.5@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b
• actions/setup-node v4.0.2@60edb5dd545a775178f52524783378180af0d1f8

npm

package.json

• lodash.capitalize ^4.2.1
• lodash.escaperegexp ^4.1.2
• lodash.isplainobject ^4.0.6
• lodash.isstring ^4.0.1
• lodash.uniqby ^4.7.0
• ava 6.1.3
• codecov 3.8.3
• lockfile-lint 4.13.2
• ls-engines 0.9.1
• npm-run-all2 6.1.2
• nyc 15.1.0
• publint 0.2.7
• xo 0.28.3
• node ^18.17 || >=20.6.1

nvm

.nvmrc

• node 20

---

• Check this box to trigger a request for Renovate to run again on this repository

Can i parse org/private repo issues??

Can i parse org/private repo issues??

An in-range update of semantic-release is breaking the build 🚨

Version 15.9.2 of semantic-release was just published.

Branch	Build failing 🚨
Dependency	semantic-release
Current Version	15.9.1
Type	devDependency

This version is covered by your current version range and after updating it in your project the build failed.

semantic-release is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ continuous-integration/travis-ci/push: The Travis CI build could not complete due to an error (Details).

---

Release Notes

v15.9.2

15.9.2 (2018-07-30)

Bug Fixes

• also hide sensitive info when loggin from cli.js (43d0646)

Commits

The new version differs by 1 commits.

• 43d0646 fix: also hide sensitive info when loggin from cli.js

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

An in-range update of semantic-release is breaking the build 🚨

Version 15.9.1 of semantic-release was just published.

Branch	Build failing 🚨
Dependency	semantic-release
Current Version	15.9.0
Type	devDependency

This version is covered by your current version range and after updating it in your project the build failed.

semantic-release is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ continuous-integration/travis-ci/push: The Travis CI build could not complete due to an error (Details).

---

Release Notes

v15.9.1

15.9.1 (2018-07-30)

Bug Fixes

• clarify EPLUGINCONF error message (d8c84a0)

Commits

The new version differs by 3 commits.

• b2d82c2 docs: specify for each step if one or more plugins are required/allowed
• 31ec1eb docs: fix configuration doc syntax
• d8c84a0 fix: clarify EPLUGINCONF error message

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

Handle multiple comma separated actions.

Parser configuration

parse('github')

Text to parse

Fixes #1,#2

Current Behavior

{ actions:
   [ { raw: 'Fixes #1',
       action: 'Fixes',
       slug: undefined,
       prefix: '#',
       issue: '1' } ],
  refs: [ { raw: '#2', slug: undefined, prefix: '#', issue: '2' } ],
  duplicates: [],
  mentions: [] }

Expected behavior

Should return 2 actions instead of 1 action and 1 ref.

Handle Gitlab closing comma separated actions

Parser configuration

const issueParser = require('issue-parser');
const parse = issueParser('gitlab');

Text to parse

From: Managing Issues > Default closing pattern

Awesome commit message

Fix #20, Fixes #21 and Closes group/otherproject#22.
This commit is also related to #17 and fixes #18, #19
and https://gitlab.com/group/otherproject/issues/23.

Current Behavior

{
  "actions": {
    "close": [
      {
        "raw": "Fix #20",
        "action": "Fix",
        "prefix": "#",
        "issue": "20"
      },
      {
        "raw": "Fixes #21",
        "action": "Fixes",
        "prefix": "#",
        "issue": "21"
      },
      {
        "raw": "Closes group/otherproject#22",
        "action": "Closes",
        "slug": "group/otherproject",
        "prefix": "#",
        "issue": "22"
      },
      {
        "raw": "fixes #18",
        "action": "Fixes",
        "prefix": "#",
        "issue": "18"
      }
    ],
    "duplicate": []
  },
  "refs": [
    {
      "raw": "#17",
      "prefix": "#",
      "issue": "17"
    },
    {
      "raw": "#19",
      "prefix": "#",
      "issue": "19"
    },
    {
      "raw": "https://gitlab.com/group/otherproject/issues/23",
      "slug": "group/otherproject",
      "issue": "23"
    }
  ],
  "mentions": []
}

Expected behavior

Issue 19 and 23 should be interpreted as close.

If it helps, their parser code is at: closing_issue_extractor.rb

{
  "actions": {
    "close": [
      {
        "raw": "Fix #20",
        "action": "Fix",
        "prefix": "#",
        "issue": "20"
      },
      {
        "raw": "Fixes #21",
        "action": "Fixes",
        "prefix": "#",
        "issue": "21"
      },
      {
        "raw": "Closes group/otherproject#22",
        "action": "Closes",
        "slug": "group/otherproject",
        "prefix": "#",
        "issue": "22"
      },
      {
        "raw": "fixes #18",
        "action": "Fixes",
        "prefix": "#",
        "issue": "18"
      },
      {
        "raw": "#19",
        "prefix": "#",
        "issue": "19"
      },
      {
        "raw": "https://gitlab.com/group/otherproject/issues/23",
        "slug": "group/otherproject",
        "issue": "23"
      }
    ],
    "duplicate": []
  },
  "refs": [
    {
      "raw": "#17",
      "prefix": "#",
      "issue": "17"
    },
    {
      "raw": "#19",
      "prefix": "#",
      "issue": "19"
    },
    {
      "raw": "https://gitlab.com/group/otherproject/issues/23",
      "slug": "group/otherproject",
      "issue": "23"
    }
  ],
  "mentions": []
}

An in-range update of codecov is breaking the build 🚨

Version 3.0.3 of codecov was just published.

Branch	Build failing 🚨
Dependency	codecov
Current Version	3.0.2
Type	devDependency

This version is covered by your current version range and after updating it in your project the build failed.

codecov is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ continuous-integration/travis-ci/push The Travis CI build could not complete due to an error Details

---

Release Notes

v3.0.3

Fix for not git repos

Commits

The new version differs by 3 commits.

• 15cdae3 v3.0.3
• 39dc2d8 Support non-git/hg root dirs (#75)
• a19efbe Updated readme

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

Does recognize fixes to issues in other repos

Parser configuration

using github

Text to parse

"Fix: https://github.com///issues/5",

Current Behavior

Recognizes this as a reference, but not a close

Expected behavior

This would be picked up as a close action