Feature/GitHub releases documentation #12
Conversation
- Add automatic CHANGELOG.md updates in release workflow - Create generate_changelog_entry.py for local CHANGELOG generation - Implement commit-message-based categorization (feat, fix, docs, etc.) - Add comprehensive CHANGELOG_AUTOMATION.md documentation - Support for Keep a Changelog format with proper versioning - Automatic date insertion and proper markdown formatting
- Import all 18 previous GitHub releases (v1.3.0 to v1.11.0) - Structure CHANGELOG according to Keep a Changelog format - Categorize changes as Added/Fixed/Changed based on commit messages - Add proper versioning documentation and support links - Clean and professional formatting for better readability - Maintain chronological order (newest first) for easy navigation
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
This is the final PR Bugbot will review for you during this billing cycle.
Your free Bugbot reviews will reset on October 25
Details
You are on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle.
To receive Bugbot reviews on all of your PRs, please upgrade to Bugbot Pro by visiting the Cursor dashboard. Your first 14 days will be free!
| break | ||
|
|
||
| # Wenn wir eine automatisch generierte Sektion am Anfang haben, überspringen | ||
| if insert_pos < len(lines) and '# [1.4.0]' in lines[0]: |
There was a problem hiding this comment.
Bug: Changelog Update Fails on Version Mismatch
The update_changelog function contains a hardcoded check for "# [1.4.0]" when determining the changelog insertion point. This makes the logic version-specific, leading to incorrect placement of new entries if the CHANGELOG.md file starts with a different version.
| r'^(chore|build|ci)(\(.+\))?: ': ('Technical', 'Technische Änderungen'), | ||
| r'^(perf|performance)(\(.+\))?: ': ('Performance', 'Performance-Verbesserungen'), | ||
| r'^(security|sec)(\(.+\))?: ': ('Security', 'Sicherheit'), | ||
| r'^Merge[[:space:]]pull[[:space:]]request': ('Added', 'Pull Request merged') |
There was a problem hiding this comment.
Bug: Regex Whitespace Issue in Commit Categorization
The categorize_commit function uses [[:space:]] in the merge commit regex. This POSIX character class is not valid in Python's re module, preventing the pattern from matching whitespace. Consequently, merge commit messages are not correctly categorized.
| EOF | ||
| # Rest der CHANGELOG (ab Zeile 8) anhängen, aber erste automatische Einträge überspringen | ||
| sed -n '8,$p' CHANGELOG.md.bak >> CHANGELOG.md |
There was a problem hiding this comment.
Bug: Changelog Parsing Error Due to Fixed Line Number
The sed command's hardcoded line number 8 for appending the changelog is fragile. It assumes a fixed file structure and minimum length, which can lead to incorrect parsing, missing content, or corruption of CHANGELOG.md.
No description provided.