Version 3.4.0

Added

• Added new command adr generate toc to generate a table of contents (TOC). See issue 60.
• To generate the TOC the handlebars library is used and the templating language for TOCs (not ADRs) has been changed. This is documented in ADR 11.

Changed

• Build has been modified to be backward compatible with Java 11, but still use Java 21 for development. This is documented in ADR 10. Thanks to Sebastian Davids for PR #57 and PR #59.

Fixed

• Corrected issue 61.

Deprecated

• Binary compatability with Java 11

Version 3.3.1

Fixed

• Issue 54 corrected. Many thanks to Wesley Viana for first identifying this and to Sebastian Davids for providing the solution.

Changed

• 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.

Removed

• Build support for GraalVM HAS BEEN DROPPED. See details as to why.

3.3.0

Version 3.3.0

Added

• Added year as template attribute (see issue 49). Many thanks to Sebastian Davids for the PR.
• Added author.email as template attribute and the corresponding configuration (see issue 49). Many thanks to Sebastian Davids for the PR.
• Can use -V and --version options on the adr command. Achieved by modifying Version class to implement the picocli IVersionProvider interface.

Fixed

• Issue 52 corrected with the PRs from Sebastian Davids. Thanks.

3.2.3

Summary

• Easier installation with jbang.
• Uses Java 21.
• Documentation updates.

Changed

• 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

• Fixed issue 45.

3.2.2

Release 3.2.2 covers a number of fixes.

Added

• CI build now done with GitHub actions

Changed

• 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

• 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.properties file (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 behavior 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.

Change to environment variable and some housekeeping

This release is to tidy up some loose ends after a pause in development and incorporate the change in how environment variables are handled.

Changed

• Refactored date/time handling
• Now uses environment variables prefixed with "ADR_" (iss #4)) (thanks Dymytro Kovalchuk)

Commands edit and config, author template field and ISO dates

Added

• 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).
• Simple manual pages in markdown format
• 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.md following keep a changelog (iss #17) (thanks Oliver Kopp).

Changed

• Now using picocli 4.1.2
• Minor fixes (iss #20) (thanks Oliver Kopp)
• Unit tests enabled in gradle build (iss #29) (thanks Sebastian Davids)

User defined templates

Major refactor to allow users to specify their own templates for ADRs.

Fixes the following issues:
#6 - See the instructions in README
#15 - As templates can be user defined, they can use other formats such as ASCIIDOC.

Refactor - CLI

This release contains no new functionality. Instead it is a major refactoring of the code to use the Picocli command line processing in preparation for new functionality. See ADR 006.

Unix release

Both Windows and Unix version release.

• Works with in-process/terminal editors such as vi
• Unix launch script