$ changelog initialize changelog: Main: ERROR: The following options are required: [--ticket-system-name], [--ticket-system-uri], [--project] $ changelog initialize \ --ticket-system-name com.github.io7m.example \ --ticket-system-uri https://www.github.com/io7m/example/issues/ \ --project com.io7m.example $ changelog initialize \ --ticket-system-name com.github.io7m.example \ --ticket-system-uri https://www.github.com/io7m/example/issues/ \ --project com.io7m.example changelog: CLCommandInitialize: ERROR: File README-CHANGES.xml already exists
$ changelog release-begin $ changelog release-begin changelog: CLCommandReleaseBegin: ERROR: A release with version 4.0.0 is already open
$ changelog release-current changelog: CLCommandReleaseCurrent: ERROR: No current release exists $ changelog release-begin $ changelog release-current 1.0.0 (open) $ changelog release-finish $ changelog release-current 1.0.0 (closed)
$ git branch develop $ changelog release-begin --version 1.0.0 $ changelog release-current 1.0.0 (open) ... <development work happens here> ... $ changelog change-add --summary 'Implemented something' ... <development work happens here> ... $ changelog change-add --summary 'Implemented something else' ... <development work happens here> ... $ git flow release start 1.0.0 $ changelog release-finish $ git flow release finish ... <git flow asks for commit and merge messages> <developer uses $ changelog write-plain to generate nice messages>
$ changelog change-add --summary 'Broke something' $ changelog change-add --summary 'Broke something new' --ticket 230 --ticket 2391 $ changelog release-finish $ changelog change-add --summary 'Broke something else' changelog: CLCommandChangeAdd: ERROR: The current release is not open for modification.
$ changelog release-finish $ changelog release-finish changelog: CLCommandReleaseFinish: ERROR: No release is currently open $ changelog add-change --summary 'Did something' changelog: CLCommandChangeAdd: ERROR: The current release is not open for modification.
$ changelog write-plain Release: com.io7m.changelog 4.0.0 Change: (Backwards incompatible) Remove Vavr Change: (Backwards incompatible) Modernize command-line interface with double-hyphen options Change: Improve spacing in plain text log (Ticket: #11) Change: Change command-line interface to explicit start and finish releases Change: (Backwards incompatible) Completely redesign the changelog format and remove the use of XOM Change: com.io7m.changelog.maven_plugin: (Backwards incompatible) Remove the Maven plugin Change: (Backwards incompatible) Remove the com.io7m.jnull dependency Change: (Backwards incompatible) Require JDK 9 $ changelog write-plain --show-dates true 2020-12-10 Release: com.io7m.changelog 4.0.0 2020-12-10 Change: (Backwards incompatible) Remove Vavr 2020-12-10 Change: (Backwards incompatible) Modernize command-line interface with double-hyphen options 2020-12-10 Change: Improve spacing in plain text log (Ticket: #11) 2020-12-10 Change: Change command-line interface to explicit start and finish releases 2017-11-11 Change: (Backwards incompatible) Completely redesign the changelog format and remove the use of XOM 2017-11-03 Change: com.io7m.changelog.maven_plugin: (Backwards incompatible) Remove the Maven plugin 2017-11-03 Change: (Backwards incompatible) Remove the com.io7m.jnull dependency 2017-11-03 Change: (Backwards incompatible) Require JDK 9 $ changelog write-plain --show-dates true --version 3.1.0 2017-10-15 Release: com.io7m.changelog 3.1.0 2017-10-15 Change: Rename project. Use the new primogenitor POM and 2017 project conventions.