All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and from version 3.2 this project adheres to Semantic Versioning.
- Build has been modified to be backward compatible with Java 11, but still use Java 21 for development. Thanks to Sebastian Davids for the PR #57.
- Java version 11 will not be supported in new releases that use Java 25 (the next planned LTS) and beyond.
- Issue 54 corrected. Many thanks to Wesley Viana for first identifying this and to Sebastian Davids for providing the solution.
- Issue 56 Upgraded to use version 8.10 of Gradle and changed the gradle build script to use Kotlin. Build script is now
build.gradle.kts. Also the dependencies have been updated. Thanks to Sebastian Davids for PR #56.
- Build support for GraalVM HAS BEEN DROPPED. See details as to why.
- Added
yearas template attribute (see issue 49). Many thanks to Sebastian Davids for the PR. - Added
author.emailas template attribute and the corresponding configuration (see issue 49). Many thanks to Sebastian Davids for the PR. - Can use
-Vand--versionoptions on theadrcommand. Achieved by modifingVersionclass to implement the picocliIVersionProviderinterface.
- Issue 52 corrected with the PRs from Sebastian Davids. Thanks.
- Nothing added as yet
- Updated the installation instructions to show how JBang can be used to simpify installation. See issue 44 (many thanks to maxandersen for showing how this can be done).
- Added new Version class to make it clearer where version numbers are changed.
- Updated to use Java 21.
- Fixed issue 45.
- CI build now done with GitHub actions
- The default git and GitHub branch is now named
main. - Upgraded to use Java 17.
- Upgraded to use version 8.2 of Gradle.
- Removed deprecated Java methods.
- Fixed issue 48.
- Partial Fix issue 47. The help documentation has been corrected so that modification of superseded ADRs is not implied. (thanks cloudbackenddev for pointing this out). The main issue - editing superceded ADRs to reflect their new status - has not been corrected.
- Fixed issue 46 by providing some basic documentation of the
adr.propertiesfile (thanks Sebastian Davis for raising this). - Fixed issue 43 allowing a user to add other files and directories in the same directory as the ADRs (thanks maxandersen for pointing this out). The behaviour is now that files and directories that are not "well formed" ADRs are ignored.
- Fixed issue #39 in handling reverse links with ASCIIDOC templates (thanks Torsten Keiber)
- Fixed issue #37.
- Fixed issue #42. ADR 2 now superseded by ADR 8.
- Fixed issue #41. ADR 4 now superseded by ADR 9. Readme updated.
- No new functionality added. This release is to tidy up some loose ends after a pause in development.
- Refactored date/time handling
- Now uses environment variables prefixed with "ADR_" (iss #4)) (thanks Dymytro Kovalchuk)
- Removed dependency to JCenter (iss #35) (thanks Marcel van den Brink)
- Simple manual pages in markdown format
- Command config command added together with subcommands docPath, templateFile, author and dateFormat (iss #13)
- ISO date formats can be set using the dateFormat property in adr.properties (iss #28) (thanks Sebastian Davids)
- Add edit sub command (iss #19)
- Add author field substitution (iss #25) (thanks Sebastian Davids)
- Add version sub-command (currently gives version as 3.1.0).
- Picocli framework now as external dependency (thanks Oliver Kopp)
- Add enablement for future versions to use GraalVM native images (iss #16) (thanks Oliver Kopp)
- Add
CHANGELOG.mdfollowing keep a changelog ((iss #17)) (thanks Oliver Kopp).
- Now using picocli 4.1.2
- Minor fixes ((iss #20)) (thanks Oliver Kopp)
- Unit tests enabled in gradle build ((iss #29)) (thanks Sebastian Davids)
3.0 - 2019-06-29
- Users can specify their own templates #6
- Support of arbitrary languages for markdown files (e.g. AsciiDoc)
2.1 - 2019-06-04
2.0 - 2019-03-17
- Add support for unix (launch script, terminal support)
1.0 - 2019-02-12
Initial release