Open
Conversation
Member
joe-chacko
commented
Feb 25, 2026
- chore: remove unused imports
- docs: streamline release process doc
- chore(release): improve changelog generation and formatting
- chore: prepare release v1.6.0
- Reorganize Quick Start section to prioritize GitHub Actions workflow - Move GitHub UI method to top as recommended approach - Simplify local release steps from 4 methods to single clear path - Remove confusing 'Method A/B' structure for better clarity - Update version example from 1.5.2 to 1.5.3 throughout - Remove 'Local Testing' section (redundant with dry-run) - Improve git add command to use -p flag for selective staging BREAKING CHANGE: Remove updateChangelogForTag Gradle task - Task was redundant with updateChangelog task - updateChangelog already handles version tagging via git-cliff - Simplifies release workflow by removing duplicate functionality - Users should use updateChangelog task instead This commit improves the release documentation by making the recommended GitHub Actions workflow more prominent and removing confusing alternative methods. The removal of updateChangelogForTag task eliminates maintenance burden and potential confusion between two similar tasks.
- Update copyright year to 2026 in cliff.toml
- Enhance updateChangelog task to display version being updated
- Add --tag flag to git-cliff for proper version tagging
- Remove scope display from changelog format for cleaner output
- Add blank line after each changelog section for better readability
- Fix formatting in CHANGELOG.md with consistent blank lines
Changes to build-release.gradle:
- Pass --tag v${version} to git-cliff command
- Update console output: 'Updating CHANGELOG.md using git-cliff for v${version}...'
- Ensures changelog entries are properly tagged with release version
Changes to cliff.toml:
- Update copyright year from 2025 to 2026
- Remove scope from commit format (eliminates redundant scope display)
- Keep breaking change indicator at start of line for visibility
- Add trailing blank line after each version section
Changes to CHANGELOG.md:
- Add missing blank lines after v1.5.2 and v1.5.1 sections
- Improve formatting consistency across all changelog entries
e72efed to
95253f3
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.