semantic-release configuration

semantic-release configuration.

• Analyses commits following the Conventional Commits 1.0.0 specification.
• Generates release notes following the Conventional Commits 1.0.0 specification.
• Formats the changelog using Prettier.
• Deploys to npm, from the dist directory, with the npm entry point.
• Creates a release commit, updating the version in the package.json and the changelog.
• Creates a GitHub release.
• Adds the npm package tarball as a GitHub release asset, with the npm entry point.

• Install
• Usage
• Contributing
• Security policy
• License

Install

npm install --save-dev @vidavidorra/semantic-release-config semantic-release

Usage

Use this configuration in your project's semantic-release configuration by specifying it as string value for the extends key of the configuration, as documented in the semantic-release Configuration documentation. In your package.json this is the release key extending the configuration, as shown in the following example.

{
  "release": {
    "extends": "@vidavidorra/semantic-release-config"
  }
}

The npm entry point publishes the package to the registry, if allowed by the private setting in the package.json, and attaches the tarball to the GitHub release. That is in addition to the config of the default entry point.

{
  "release": {
    "extends": "@vidavidorra/semantic-release-config/npm"
  }
}

Contributing

Please create an issue if you have a bug report or feature proposal, or create a discussion if you have a question. If you like this project, please consider giving it a star ⭐ to support my work.

Refer to the contributing guide for detailed information about other contributions, like pull requests.

Security policy

Please refer to the Security Policy on GitHub for the security policy.

License

This project is licensed under the GPLv3 license.

Copyright © 2025-2026 Jeroen de Bruijn

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

The full text of the license is available in the LICENSE file in this repository and online