Skip to content

feat(changelog): always update changelog even without version bump#54

Merged
gsinghjay merged 2 commits intomainfrom
docs/update-workflow
Jan 2, 2025
Merged

feat(changelog): always update changelog even without version bump#54
gsinghjay merged 2 commits intomainfrom
docs/update-workflow

Conversation

@gsinghjay
Copy link
Owner

Description

This PR enhances our release documentation and improves our changelog automation by ensuring all changes are tracked, even those that don't trigger version bumps.

Added

  • Comprehensive documentation for:
    • Semantic Versioning principles and rules
    • Keep a Changelog guidelines
    • Python Semantic Release configuration
  • New feature: Always update changelog even without version bumps
    [tool.python_semantic_release.changelog]
    always_update = true

Changed

  • Updated author information in pyproject.toml
  • Enhanced documentation structure and readability
  • Improved changelog configuration to capture all changes

Documentation Updates

  • Added version bumping rules with commit type mappings
  • Added changelog guidelines with practical examples
  • Detailed explanation of automated release process
  • Added configuration documentation with inline comments
  • Added explanation of changelog automation features

Technical Details

The always_update = true configuration ensures:

  • All commits are tracked in CHANGELOG.md
  • Changes appear in "Unreleased" section even without version bump
  • Complete history of all changes is maintained
  • Non-versioning commits (docs, chore) are properly documented

Checklist

  • Documentation is clear and comprehensive
  • Configuration examples are accurate and tested
  • Commit messages follow conventional commits
  • Changelog configuration is properly set up
  • All changes are documented in README.md

Related Documentation

@gsinghjay gsinghjay merged commit f2bdb44 into main Jan 2, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant