io7m | single-page | multi-page
4.10. write-atom
4. Command-Line Interface
4.12. write-xhtml

write-plain

Name

write-plain - Produce a humanly-readable plain text log

Description

The write-plain command produces a plain text version of a changelog. The command is expected to be used in software release metadata, commit messages, and etc. The command can produce output for a specific version, and produces output for the most recent version if no version is specified.

4.11.2.2 Parameters

Parameter Type Required Description
--file Path false Set the name of the changelog file.
--verbose Log Level false Set the minimum logging verbosity level.
--version Version false The release version.
--count Integer false The number of releases to show.
--show-dates Boolean false Show the date of each change.

Example

4.11.3.1 Example

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

      
4.10. write-atom
4. Command-Line Interface
4.12. write-xhtml
io7m | single-page | multi-page