|
| 1 | +# Changelog |
| 2 | + |
| 3 | +All notable changes to this project will be documented in this file. |
| 4 | + |
| 5 | +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), |
| 6 | +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
| 7 | + |
| 8 | +## [Unreleased] |
| 9 | + |
| 10 | +### Added |
| 11 | +- Java 23 support across all workflows (java-ci-universal.yml, java-ci-secure.yml) |
| 12 | +- New composite action: `setup-java-gradle` for Gradle project setup with caching |
| 13 | +- New composite action: `security-scan` for comprehensive security scanning |
| 14 | +- New composite action: `artifact-publish` for publishing to multiple repositories |
| 15 | +- New workflow: `ci-security.yml` for comprehensive security scanning |
| 16 | + - CodeQL SAST analysis |
| 17 | + - OWASP Dependency-Check |
| 18 | + - Trivy vulnerability scanning |
| 19 | + - Snyk integration (optional) |
| 20 | + - Secret scanning with TruffleHog |
| 21 | +- Support for multiple Java distributions (Temurin, Zulu, Liberica, Corretto, Microsoft, Oracle) |
| 22 | +- Enhanced Gradle support with wrapper detection |
| 23 | +- Artifact publishing to multiple targets: |
| 24 | + - GitHub Packages |
| 25 | + - Maven Central (OSSRH) |
| 26 | + - Sonatype Nexus |
| 27 | + - JFrog Artifactory |
| 28 | + - AWS CodeArtifact |
| 29 | +- GPG signing support for Maven Central publishing |
| 30 | +- Security score calculation (A+ to F rating) |
| 31 | +- Dry-run mode for artifact publishing |
| 32 | + |
| 33 | +### Changed |
| 34 | +- Updated java-ci-universal.yml to version 2.1.0 |
| 35 | +- Enhanced Java version validation to include Java 23 |
| 36 | +- Improved documentation with comprehensive header comments |
| 37 | + |
| 38 | +### Deprecated |
| 39 | +- Java 8 support will be deprecated in v3.0.0 (6 months notice) |
| 40 | + |
| 41 | +## [2.0.5] - 2025-01-XX |
| 42 | + |
| 43 | +### Added |
| 44 | +- GitHub automatic release notes generation |
| 45 | +- Enhanced release workflow with improved changelog generation |
| 46 | + |
| 47 | +### Changed |
| 48 | +- Updated release-workflows.yml with automatic release notes |
| 49 | + |
| 50 | +## [2.0.4] - 2025-01-XX |
| 51 | + |
| 52 | +### Fixed |
| 53 | +- Added explicit `shell: bash` to all run steps for cross-platform compatibility |
| 54 | +- Fixed shell script execution issues on Windows runners |
| 55 | + |
| 56 | +## [2.0.3] - 2025-01-XX |
| 57 | + |
| 58 | +### Changed |
| 59 | +- Updated deprecated GitHub Actions to latest versions |
| 60 | +- Improved action version pinning |
| 61 | + |
| 62 | +## [2.0.2] - 2025-01-XX |
| 63 | + |
| 64 | +### Fixed |
| 65 | +- Fixed JSON parsing and generation reliability |
| 66 | +- Improved error handling in workflow validation |
| 67 | + |
| 68 | +## [2.0.1] - 2025-01-XX |
| 69 | + |
| 70 | +### Fixed |
| 71 | +- Fixed JSON parsing errors in workflow outputs |
| 72 | + |
| 73 | +## [2.0.0] - 2025-01-XX |
| 74 | + |
| 75 | +### Added |
| 76 | +- Enhanced Java CI workflow supporting both Maven and Gradle |
| 77 | +- Gradle version configuration |
| 78 | +- Multiple build tool support in single workflow |
| 79 | +- Enhanced coverage tool selection (JaCoCo, Cobertura) |
| 80 | +- Parallel execution capabilities |
| 81 | +- Improved matrix testing |
| 82 | + |
| 83 | +### Changed |
| 84 | +- Enhanced workflow naming and organization |
| 85 | +- Improved input validation |
| 86 | +- Better error messages and logging |
| 87 | + |
| 88 | +## [1.0.0] - 2025-01-XX |
| 89 | + |
| 90 | +### Added |
| 91 | +- Initial stable release |
| 92 | +- Java CI workflow with Maven support (java-ci-secure.yml) |
| 93 | +- Support for Java 8, 11, 17, 21, 22 |
| 94 | +- Matrix testing support (multiple OS and Java versions) |
| 95 | +- JaCoCo code coverage integration |
| 96 | +- Composite action: setup-java-maven |
| 97 | +- Composite action: docker-build-push |
| 98 | +- Auto-tagging workflow with Docker build support |
| 99 | +- Branch cleanup workflow |
| 100 | +- Dependabot auto-merge workflow |
| 101 | +- Release management workflow |
| 102 | +- Workflow testing and validation |
| 103 | +- Security best practices: |
| 104 | + - Fine-grained permissions |
| 105 | + - Input validation |
| 106 | + - SHA-pinned actions |
| 107 | +- Slack notification integration |
| 108 | +- Comprehensive documentation |
| 109 | +- Example workflows |
| 110 | +- Versioning strategy documentation (VERSIONING.md) |
| 111 | + |
| 112 | +### Security |
| 113 | +- Implemented security hardening across all workflows |
| 114 | +- Added security scanning in test workflows |
| 115 | +- Secrets management best practices |
| 116 | + |
| 117 | +--- |
| 118 | + |
| 119 | +## Version History Summary |
| 120 | + |
| 121 | +| Version | Release Date | Key Features | |
| 122 | +|---------|-------------|--------------| |
| 123 | +| **Unreleased** | TBD | Java 23, Security scanning, Artifact publishing, Gradle support | |
| 124 | +| **2.0.5** | 2025-01 | Automatic release notes | |
| 125 | +| **2.0.4** | 2025-01 | Cross-platform shell support | |
| 126 | +| **2.0.3** | 2025-01 | Updated GitHub Actions | |
| 127 | +| **2.0.2** | 2025-01 | JSON parsing fixes | |
| 128 | +| **2.0.1** | 2025-01 | JSON parsing improvements | |
| 129 | +| **2.0.0** | 2025-01 | Maven + Gradle support | |
| 130 | +| **1.0.0** | 2025-01 | Initial stable release | |
| 131 | + |
| 132 | +--- |
| 133 | + |
| 134 | +## Upgrade Guides |
| 135 | + |
| 136 | +### Upgrading from 2.0.x to 2.1.0 |
| 137 | + |
| 138 | +**New Features Available:** |
| 139 | +- Java 23 support (add to your java-version input) |
| 140 | +- New `setup-java-gradle` composite action for Gradle projects |
| 141 | +- New `ci-security.yml` workflow for security scanning |
| 142 | +- New `artifact-publish` composite action for publishing |
| 143 | + |
| 144 | +**Breaking Changes:** |
| 145 | +- None (fully backward compatible) |
| 146 | + |
| 147 | +**Recommended Actions:** |
| 148 | +1. Update your workflow references from `@v2.0.x` to `@v2.1.0` |
| 149 | +2. Consider adding security scanning workflow to your pipeline |
| 150 | +3. Test Java 23 compatibility in your projects |
| 151 | +4. Review new Gradle setup action for better caching |
| 152 | + |
| 153 | +### Upgrading from 1.x to 2.x |
| 154 | + |
| 155 | +**New Features Available:** |
| 156 | +- Gradle build tool support |
| 157 | +- Enhanced coverage tools (JaCoCo, Cobertura) |
| 158 | +- Better parallel execution |
| 159 | +- Improved matrix testing |
| 160 | + |
| 161 | +**Breaking Changes:** |
| 162 | +- None (1.x workflows still available) |
| 163 | + |
| 164 | +**Recommended Actions:** |
| 165 | +1. If using Gradle, switch to `java-ci-universal.yml` workflow |
| 166 | +2. Review new input options for customization |
| 167 | +3. Test with your existing projects before full rollout |
| 168 | + |
| 169 | +--- |
| 170 | + |
| 171 | +## Future Roadmap |
| 172 | + |
| 173 | +### Planned for v3.0.0 |
| 174 | +- [ ] GraalVM native-image build support |
| 175 | +- [ ] Performance benchmarking (JMH integration) |
| 176 | +- [ ] Contract testing support (Pact, Spring Cloud Contract) |
| 177 | +- [ ] Enhanced test reporting (Allure, Serenity) |
| 178 | +- [ ] Multi-module project optimization |
| 179 | +- [ ] Remove Java 8 support (deprecated) |
| 180 | + |
| 181 | +### Under Consideration |
| 182 | +- [ ] Kubernetes deployment workflows |
| 183 | +- [ ] Cloud-native deployment support |
| 184 | +- [ ] Chaos engineering integration |
| 185 | +- [ ] Advanced caching strategies |
| 186 | +- [ ] IDE integration guides |
| 187 | + |
| 188 | +--- |
| 189 | + |
| 190 | +## Contributing |
| 191 | + |
| 192 | +We welcome contributions! Please see our contributing guidelines for details on: |
| 193 | +- Reporting bugs |
| 194 | +- Suggesting enhancements |
| 195 | +- Submitting pull requests |
| 196 | +- Code style and standards |
| 197 | + |
| 198 | +--- |
| 199 | + |
| 200 | +## Support |
| 201 | + |
| 202 | +For questions, issues, or feature requests: |
| 203 | +- Open an issue in this repository |
| 204 | +- Check existing documentation in README.md and VERSIONING.md |
| 205 | +- Review example workflows in the `examples/` directory |
| 206 | + |
| 207 | +--- |
| 208 | + |
| 209 | +**Note:** This changelog is automatically generated from commit messages and release notes. |
| 210 | +Manual updates are made for major releases and breaking changes. |
0 commit comments