Skip to content

Commit 0e114c3

Browse files
committed
refactor(config)!: change changelog.default_templates.mask_initial_release default to true
Changes the default behavior of PSR when `mask_initial_release` setting is not provided. BREAKING CHANGE: This release switches the `changelog.default_templates.mask_initial_release` default to `true`. This change is intended to toggle better recommended outputs of the default changelog. Conceptually, the very first release is hard to describe--one can only provide new features as nothing exists yet for the end user. No changelog should be written as there is no start point to compare the "changes" to. The recommendation instead is to only list a simple message as `Initial Release`. This is now the default for PSR when providing the very first release (no pre-existing tags) in the changelog and release notes. If your configuration already sets the `changelog.default_templates.mask_initial_release` value, then this change will have no effect on your project. If you do NOT want to mask the first release information, then set `changelog.default_templates.mask_initial_release` to `false` in your configuration.
1 parent 7f6899e commit 0e114c3

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

src/semantic_release/cli/config.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,8 +128,7 @@ class ChangelogEnvironmentConfig(BaseModel):
128128
class DefaultChangelogTemplatesConfig(BaseModel):
129129
changelog_file: str = "CHANGELOG.md"
130130
output_format: ChangelogOutputFormat = ChangelogOutputFormat.NONE
131-
# TODO: Breaking Change v10, it will become True
132-
mask_initial_release: bool = False
131+
mask_initial_release: bool = True
133132

134133
@model_validator(mode="after")
135134
def interpret_output_format(self) -> Self:

0 commit comments

Comments
 (0)