Skip to content

feature-scan.md

Latest commit

 

History

History
67 lines (52 loc) · 3.29 KB

feature-scan.md

File metadata and controls

67 lines (52 loc) · 3.29 KB

Scan command

The scan command summarizes the content of changelog files to provide a quick overview of a repository. It reports release count, date range, versioning compatibility, forge information, and unreleased changes.

Usage examples

CLI

$ heylogs scan --output summary.txt --format json
# Summarizes changelog content in JSON format and writes to summary.txt

Maven plugin

<plugin>
    <groupId>com.github.nbbrd.heylogs</groupId>
    <artifactId>heylogs-maven-plugin</artifactId>
    <executions>
        <execution>
            <goals>
                <goal>scan</goal>
            </goals>
            <configuration>
                <outputFile>summary.txt</outputFile>
                <format>json</format>
                <inputFiles>
                    <inputFile>CHANGELOG.md</inputFile>
                </inputFiles>
                <recursive>true</recursive>
            </configuration>
        </execution>
    </executions>
</plugin>

Parameters

Changelog input parameters

Parameter Description CLI Maven Plugin
inputFile(s) Changelog file(s) to scan (default: CHANGELOG.md, supports multiple files) <source> (positional, default: CHANGELOG.md) <inputFiles>CHANGELOG.md</inputFiles>
recursive Recursively search for changelog files --recursive <recursive>true</recursive>

Output parameters

Parameter Description CLI Maven Plugin
outputFile Output file for result --output <file> <outputFile>summary.txt</outputFile>
format Output format (stylish, json) --format <id> <format>json</format>

Configuration options

Parameter Description CLI Maven Plugin
noConfig Ignore config files --no-config <noConfig>true</noConfig>
versioning Versioning scheme --versioning <scheme> <versioning>semver</versioning>
tagging Tagging strategy --tagging <strategy> <tagging>prefix:v</tagging>
forge Forge platform --forge <platform> <forge>github</forge>
rules Rule overrides (comma-separated) --rule <id:severity> <rules>no-empty-group:WARN,...</rules>
domains Domain mappings (comma-separated) --domain <domain:forge> <domains>gitlab.company.com:gitlab</domains>

← Back to README