Skip to content

Commit f2bdb44

Browse files
authored
Merge pull request #54 from gsinghjay/docs/update-workflow
feat(changelog): always update changelog even without version bump
2 parents 4a7df38 + 995a65a commit f2bdb44

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,12 @@ changelog_sections = [ # Keep a Changelog categories
300300
"refactor"
301301
]
302302
303+
# Changelog Behavior
304+
include_unreleased = true # Track upcoming changes
305+
always_update = true # Update changelog even without version bump
306+
render_commit_links = true # Add links to commits
307+
render_title = true # Include version headers
308+
303309
# Release Settings
304310
upload_to_repository = false
305311
build_command = "poetry build"
@@ -322,6 +328,9 @@ tag_type = "annotated" # Use annotated tags for better documentation
322328
- Includes release dates and version links
323329
- Keeps an Unreleased section for upcoming changes
324330
- Links to Git comparisons between versions
331+
- Updates changelog even for non-version-bumping changes
332+
- Tracks all commits in the Unreleased section
333+
- Provides complete history of all changes
325334

326335
### Manual Release Commands
327336

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,3 +82,4 @@ render_title = true
8282
render_commit_links = true
8383
include_unreleased = true
8484
unreleased_section_title = "Unreleased"
85+
always_update = true

0 commit comments

Comments
 (0)