Lewati ke konten utama

Scope dan Type Mappings

Scope dan Type Mappings

Active and Extensible

Ubah machine-oriented commit classification menjadi stable dan 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โ€‹

Setiap key merupakan raw commit scope; setiap value merupakan displayed scope. Unmapped scopes mempertahankan nama aslinya.

Generated scope_map entries

PropertyTypeDescriptionDefaultRequired
mainTampilkan main sebagai core.coreNo
authPerluas authentication scope.authenticationNo
cliPertahankan CLI labeling.cliNo
changelogPertahankan changelog labeling.changelogNo
workflowPertahankan workflow labeling.workflowNo
templatePertahankan template labeling.templateNo
configPerluas config menjadi configuration.configurationNo
docsPerluas docs menjadi documentation.documentationNo
testsPertahankan tests labeling.testsNo

Type Mappingโ€‹

Mapping juga menyediakan stable group order ketika sort_groups = false. Unknown types menggunakan value milik other.

Generated type_map entries

PropertyTypeDescriptionDefaultRequired
featNew user-facing functionality.โœจ FeaturesNo
fixCorrective changes.๐Ÿ› Bug FixesNo
improvementEnhancements yang bukan 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 dan delivery changes.โš™๏ธ CI/CDNo
buildBuild-system changes.๐Ÿ—๏ธ BuildNo
releaseRelease-oriented commits.๐Ÿš€ ReleasesNo
revertReverted changes.โ†ฉ๏ธ RevertsNo
styleFormatting atau style-only changes.๐ŸŽจ StylingNo
otherFallback title untuk unknown commit types.๐Ÿ“ฆ OthersNo
Custom mapping
toml
[tool.custy.changelog.scope_map]
database = "data layer"

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

Lanjutkan