Skip to content

usage-enforcer-rules.md

Latest commit

 

History

History
180 lines (147 loc) · 3.75 KB

usage-enforcer-rules.md

File metadata and controls

180 lines (147 loc) · 3.75 KB

Maven Enforcer rules

The heylogs Maven Enforcer rule checkChangelog integrates changelog validation directly into Maven's enforcer plugin, allowing you to enforce changelog quality standards as part of your build process. The build fails if the changelog doesn't meet the configured requirements.

Quick start

Add the enforcer plugin with the heylogs custom rule to your pom.xml:

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-enforcer-plugin</artifactId>
            <version>3.5.0</version>
            <dependencies>
                <dependency>
                    <groupId>com.github.nbbrd.heylogs</groupId>
                    <artifactId>heylogs-enforcer-rules</artifactId>
                    <version>_VERSION_</version>
                </dependency>
            </dependencies>
            <executions>
                <execution>
                    <id>enforce-changelog</id>
                    <goals>
                        <goal>enforce</goal>
                    </goals>
                    <configuration>
                        <rules>
                            <checkChangelog>
                                <versioning>semver</versioning>
                            </checkChangelog>
                        </rules>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

Configuration parameters

Input/Output parameters

inputFiles

List of changelog files to validate.

Type: List<File>
Default: ${project.basedir}/CHANGELOG.md
Example:

<inputFiles>
    <inputFile>${project.basedir}/CHANGELOG.md</inputFile>
    <inputFile>${project.basedir}/docs/HISTORY.md</inputFile>
</inputFiles>

recursive

Search for changelog files recursively in directories.

Type: boolean
Default: false
Example:

<recursive>true</recursive>

outputFile

File to write validation results to.

Type: File
Default: stdout (console output)
Example:

<outputFile>${project.build.directory}/changelog-report.txt</outputFile>

Validation parameters

versioning

Versioning scheme to validate version numbers.

Type: String
Default: none
Values: semver, calver:PATTERN, regex:PATTERN
Example:

<versioning>semver</versioning>

tagging

Tag naming strategy.

Type: String
Default: none
Example:

<tagging>prefix:v</tagging>

forge

Source code hosting platform.

Type: String
Default: none
Values: github, gitlab, forgejo
Example:

<forge>github</forge>

rules

Rule severity overrides (comma-separated).

Type: List<String>
Default: none
Example:

<rules>
    <rule>no-empty-group:WARN</rule>
    <rule>release-date:ERROR</rule>
</rules>

domains

Custom forge domain mappings.

Type: List<String>
Default: none
Example:

<domains>
    <domain>gitlab.company.com:gitlab</domain>
    <domain>github.enterprise.com:github</domain>
</domains>

format

Output format for validation results.

Type: String
Default: stylish (human-readable)
Values: stylish, json
Example:

<format>json</format>

Control parameters

skip

Skip the enforcer rule execution.

Type: boolean
Default: false
Example:

<skip>true</skip>

Or via command-line:

mvn clean install -Denforcer.skip=true

noConfig

Ignore heylogs.properties configuration files.

Type: boolean
Default: false
Example:

<noConfig>true</noConfig>

← Back to README