Skip to main content

Scope and Type Mappings

Scope and Type Mappings

Active and Extensible

Translate machine-oriented commit classification into stable, reader-friendly section names.

Command[tool.custy.changelog.scope_map] + [tool.custy.changelog.type_map]

Category

Changelog Configuration

Quick Command

RAW_KEY = "Display label"

scopestypesdisplay names

Scope Mappingโ€‹

Every key is a raw commit scope; every value is the displayed scope. Unmapped scopes retain their original name.

Generated scope_map entries

PropertyTypeDescriptionDefaultRequired
mainDisplay main as core.coreNo
authExpand the authentication scope.authenticationNo
cliPreserve CLI labeling.cliNo
changelogPreserve changelog labeling.changelogNo
workflowPreserve workflow labeling.workflowNo
templatePreserve template labeling.templateNo
configExpand config to configuration.configurationNo
docsExpand docs to documentation.documentationNo
testsPreserve tests labeling.testsNo

Type Mappingโ€‹

The mapping also provides stable group order when sort_groups = false. Unknown types use the value assigned to other.

Generated type_map entries

PropertyTypeDescriptionDefaultRequired
featNew user-facing functionality.โœจ FeaturesNo
fixCorrective changes.๐Ÿ› Bug FixesNo
improvementEnhancements not classified as features.๐Ÿง  ImprovementsNo
templateTemplate changes.๐Ÿ“„ TemplatesNo
breakingBackward-incompatible changes.โš ๏ธ Breaking ChangesNo
docsDocumentation changes.๐Ÿ“š DocumentationNo
refactorInternal restructuring.๐Ÿง  RefactoringNo
perfPerformance improvements.โšก PerformanceNo
testTest changes.๐Ÿงช TestsNo
choreMaintenance work.๐Ÿ”ง ChoresNo
ciContinuous integration and delivery changes.โš™๏ธ CI/CDNo
buildBuild-system changes.๐Ÿ—๏ธ BuildNo
releaseRelease-oriented commits.๐Ÿš€ ReleasesNo
revertReverted changes.โ†ฉ๏ธ RevertsNo
styleFormatting or style-only changes.๐ŸŽจ StylingNo
otherFallback title for unknown commit types.๐Ÿ“ฆ OthersNo
Custom mapping
toml
[tool.custy.changelog.scope_map]
database = "data layer"

[tool.custy.changelog.type_map]
security = "๐Ÿ” Security"

Continue