https://github.com/volodya-lombrozo/conventional-commit-linter

Conventional Commit Linter - plugin for Maven projects https://www.conventionalcommits.org/en/v1.0.0-beta.4/
https://github.com/volodya-lombrozo/conventional-commit-linter

Last synced: about 1 month ago
JSON representation

Conventional Commit Linter - plugin for Maven projects https://www.conventionalcommits.org/en/v1.0.0-beta.4/

• Host: GitHub
• URL: https://github.com/volodya-lombrozo/conventional-commit-linter
• Owner: volodya-lombrozo
• License: mit
• Created: 2021-06-01T14:33:06.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-14T20:09:52.000Z (3 months ago)
• Last Synced: 2024-09-15T05:10:13.068Z (3 months ago)
• Language: Java
• Homepage:
• Size: 254 KB
• Stars: 8
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Conventional Commits Linter

Maven Plugin linter for [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/).  

[![codecov](https://codecov.io/gh/volodya-lombrozo/conventional-commit-linter/branch/main/graph/badge.svg?token=KmT35uwArr)](https://codecov.io/gh/volodya-lombrozo/conventional-commit-linter)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.volodya-lombrozo/conventional-commit-linter/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.volodya-lombrozo/conventional-commit-linter)

# How to use

Add the plugin to your `pom.xml` file to the plugins section.

```XML

    com.github.volodya-lombrozo

    conventional-commit-linter

    0.0.6

    

        

            

                

                    scan

                

            

        

    

```

The default maven phase is **validate**.

## Change scan mode

Available scan modes:

* **ALL** - the plugin will scan all repository commits messages one by one starting from the earliest. Conventional

  commits format will be used.

* **LAST** - the plugin will scan only the last commit. Conventional commits format will be used.

* **NOTHING** - the plugin will scan nothing. Validation will always be **successful** regardless of the commit

  messages.

* **FAIL** - the plugin will scan nothing. Validation will always be **failed** regardless of the commit messages.

The default plugin mode is the **LAST**.

In order to change a scan mode you could add the next configuration to your plugin:

```xml

    ALL

```

The full plugin example:

```xml

    com.github.volodya-lombrozo

    conventional-commit-linter

    0.0.6

    

        FAIL

    

    

        

            

                

                    scan

                

            

        

    

```