Project icon

com.io7m.changelog

Build status Maven Central Codecov

The changelog package defines a simple schema for software changelogs. It categorizes changes by type. This allows, for example, easy checking for backwards-incompatible changes on each new release of a piece of software. The changelogs can also reference ticketing systems to show that a given change fixes a given ticket.

The package also defines a set of Java classes to parse and transform changelogs.

Contents

Features

  • XSD schema for rigorously well-formed changelogs.
  • Command-line tools for manipulating and printing changelogs.
  • OSGi-ready
  • JPMS-ready
  • ISC license.
  • Automated test suite with high coverage.

Releases

The most recently published version of the software is 5.0.0-beta0002.

Source code and binaries are available from the repository.

Documentation

Documentation for the 5.0.0-beta0002 release is available for reading online.

Documentation for current and older releases is archived in the repository.

User documentation

Maven

The following is a complete list of the project's modules expressed as Maven dependencies: 

<dependency>
  <groupId>com.io7m.changelog</groupId>
  <artifactId>com.io7m.changelog</artifactId>
  <version>5.0.0-beta0002</version>
</dependency>

<dependency>
  <groupId>com.io7m.changelog</groupId>
  <artifactId>com.io7m.changelog.cmdline</artifactId>
  <version>5.0.0-beta0002</version>
</dependency>

<dependency>
  <groupId>com.io7m.changelog</groupId>
  <artifactId>com.io7m.changelog.core</artifactId>
  <version>5.0.0-beta0002</version>
</dependency>

<dependency>
  <groupId>com.io7m.changelog</groupId>
  <artifactId>com.io7m.changelog.documentation</artifactId>
  <version>5.0.0-beta0002</version>
</dependency>

<dependency>
  <groupId>com.io7m.changelog</groupId>
  <artifactId>com.io7m.changelog.schema</artifactId>
  <version>5.0.0-beta0002</version>
</dependency>

<dependency>
  <groupId>com.io7m.changelog</groupId>
  <artifactId>com.io7m.changelog.tests</artifactId>
  <version>5.0.0-beta0002</version>
</dependency>

<dependency>
  <groupId>com.io7m.changelog</groupId>
  <artifactId>com.io7m.changelog.xml.vanilla</artifactId>
  <version>5.0.0-beta0002</version>
</dependency>

<dependency>
  <groupId>com.io7m.changelog</groupId>
  <artifactId>com.io7m.changelog.xml.api</artifactId>
  <version>5.0.0-beta0002</version>
</dependency>

<dependency>
  <groupId>com.io7m.changelog</groupId>
  <artifactId>com.io7m.changelog.parser.api</artifactId>
  <version>5.0.0-beta0002</version>
</dependency>

<dependency>
  <groupId>com.io7m.changelog</groupId>
  <artifactId>com.io7m.changelog.text.api</artifactId>
  <version>5.0.0-beta0002</version>
</dependency>

<dependency>
  <groupId>com.io7m.changelog</groupId>
  <artifactId>com.io7m.changelog.writer.api</artifactId>
  <version>5.0.0-beta0002</version>
</dependency>

<dependency>
  <groupId>com.io7m.changelog</groupId>
  <artifactId>com.io7m.changelog.text.vanilla</artifactId>
  <version>5.0.0-beta0002</version>
</dependency>

Each release of the project is made available on Maven Central within ten minutes of the release announcement.

Changes

Subscribe to the releases atom feed.

2024-05-03 Release: com.io7m.changelog 5.0.0
2024-04-28 Change: (Backwards incompatible) Require JDK 17
2024-05-03 Change: Allow qualifiers in version numbers. (tickets: 24 )
2024-05-03 Change: Ensure releases are serialized in order. (tickets: 25 )
2021-01-12 Release: com.io7m.changelog 4.1.0
2021-01-12 Change: Improved documentation
2020-12-10 Release: com.io7m.changelog 4.0.0
2017-11-03 Change: (Backwards incompatible) CModuleName{value=com.io7m.changelog.maven_plugin}: 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
2017-11-11 Change: (Backwards incompatible) Completely redesign the changelog format and remove the use of XOM
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 (tickets: 11 )
2020-12-10 Change: Change command-line interface to explicit start and finish releases
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.
2017-01-10 Release: com.io7m.changelog 3.0.3
2017-01-10 Change: Fix printing of version numbers in report generation. (tickets: 3 )
2017-01-10 Release: com.io7m.changelog 3.0.2
2017-01-10 Change: Fix date formatting in report generation. (tickets: 2 )
2016-12-21 Release: com.io7m.changelog 3.0.1
2016-12-21 Change: Fix the command line frontend onejar configuration.
2016-12-21 Release: com.io7m.changelog 3.0.0
2016-12-21 Change: (Backwards incompatible) The package now requires Java 8.
2016-12-21 Change: The published artifacts are now OSGi bundles.
2016-12-21 Change: (Backwards incompatible) Consistently use com.io7m.changelog.* everywhere (some packages were rooted at com.io7m.changelogs).
2016-12-21 Change: (Backwards incompatible) Replace most of the API with Immutables.org generated types.
2016-12-21 Change: Add a command-line frontend.
2016-05-06 Release: com.io7m.changelog 2.1.2
2016-05-06 Change: Update site links and POM metadata
2015-08-22 Release: com.io7m.changelog 2.1.1
2015-08-22 Change: Migrate to GitHub.
2014-12-03 Change: Fix javadoc comments for Java 8's doclint.
2014-12-03 Change: Ensure source jars for unit tests are created.
2014-04-19 Release: com.io7m.changelog 2.1.0
2014-04-19 Change: Add Maven report plugin.
2014-04-19 Change: Add simple Atom feed generator.
2014-04-17 Release: com.io7m.changelog 2.0.0
2014-04-17 Change: Allow for zero or more releases in a file.
2014-04-17 Change: Do not allow xml:id on changelogs.
2014-04-17 Change: Allow multiple tickets per changelog item.
2014-04-17 Change: Redevelop package in Java, eliminate XSLT stylesheets.
2014-04-17 Change: (Backwards incompatible) Change schema URI and increment version to 2.0.0
2012-03-15 Release: com.io7m.changelog 1.0.0
2012-03-15 Change: Initial release.

Sources

This project uses Git to manage source code.

Repository: https://www.github.com/io7m-com/changelog

$ git clone https://www.github.com/io7m-com/changelog

License

Copyright © 2024 Mark Raynsford <code@io7m.com> https://www.io7m.com

Permission to use, copy, modify, and/or distribute this software for
any purpose with or without fee is hereby granted, provided that the
above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR
BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
SOFTWARE.

Bug Tracker

The project uses GitHub Issues to track issues.