https://github.com/nielsbasjes/conventional-commits-maven-release

A version policy for the maven-release-plugin that uses the Conventional Commits pattern.
https://github.com/nielsbasjes/conventional-commits-maven-release

conventional-commits maven-release maven-release-plugin semver

Last synced: about 2 months ago
JSON representation

A version policy for the maven-release-plugin that uses the Conventional Commits pattern.

• Host: GitHub
• URL: https://github.com/nielsbasjes/conventional-commits-maven-release
• Owner: nielsbasjes
• License: apache-2.0
• Created: 2023-03-05T22:44:06.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-13T10:15:38.000Z (9 months ago)
• Last Synced: 2024-04-14T00:38:22.102Z (9 months ago)
• Topics: conventional-commits, maven-release, maven-release-plugin, semver
• Language: Java
• Homepage: https://maven.basjes.nl/
• Size: 174 KB
• Stars: 7
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
Conventional Commits for the Maven Release Plugin

========================================

[![Github actions Build status](https://img.shields.io/github/actions/workflow/status/nielsbasjes/conventional-commits-maven-release/build.yml?branch=main)](https://github.com/nielsbasjes/conventional-commits-maven-release/actions)

[![Coverage Status](https://img.shields.io/codecov/c/github/nielsbasjes/conventional-commits-maven-release)](https://app.codecov.io/gh/nielsbasjes/conventional-commits-maven-release)

[![License](https://img.shields.io/:license-apache-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)

[![Maven Central](https://img.shields.io/maven-central/v/nl.basjes.maven.release/conventional-commits-version-policy.svg)](https://central.sonatype.com/namespace/nl.basjes.maven.release)

[![Reproducible Builds](https://img.shields.io/badge/Reproducible_Builds-ok-success?labelColor=1e5b96)](https://github.com/jvm-repo-rebuild/reproducible-central#nl.basjes.maven.release:conventional-commits-version-policy)

[![GitHub stars](https://img.shields.io/github/stars/nielsbasjes/conventional-commits-maven-release?label=GitHub%20stars)](https://github.com/nielsbasjes/conventional-commits-maven-release/stargazers)

[![If this project has business value for you then don't hesitate to support me with a small donation.](https://img.shields.io/badge/Sponsor%20me-via%20Github-red.svg)](https://github.com/sponsors/nielsbasjes)

[![If this project has business value for you then don't hesitate to support me with a small donation.](https://img.shields.io/badge/Donations-via%20Paypal-red.svg)](https://www.paypal.me/nielsbasjes)

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)

# What is this?

This is a Version Policy (_next version calculator_) for the [maven-release-plugin](https://maven.apache.org/maven-release/maven-release-plugin/) that follows the [Conventional Commits](https://www.conventionalcommits.org/) model.

So the scm tags and commit messages are automatically used to determine the next version number of your project.

The documentation can be found here: https://maven.basjes.nl

# License

    Conventional Commits Version Policy

    Copyright (C) 2022-2024 Niels Basjes

    Licensed under the Apache License, Version 2.0 (the "License");

    you may not use this file except in compliance with the License.

    You may obtain a copy of the License at

        https://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software

    distributed under the License is distributed on an "AS IS" BASIS,

    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    See the License for the specific language governing permissions and

    limitations under the License.