Skip to content

release/1.6.0#768

Open
joe-chacko wants to merge 5 commits intoOpenLiberty:mainfrom
joe-chacko:release/1.6.0
Open

release/1.6.0#768
joe-chacko wants to merge 5 commits intoOpenLiberty:mainfrom
joe-chacko:release/1.6.0

Conversation

@joe-chacko
Copy link
Member

  • 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.
@joe-chacko joe-chacko self-assigned this Feb 25, 2026
@joe-chacko joe-chacko requested a review from ngmr February 25, 2026 16:00
- 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
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