Project icon

com.io7m.changelog

Build status Maven Central Codacy 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

Releases

The current release is 4.0.0-SNAPSHOT.

Source code and binaries are available from the repository.

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>4.0.0-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.changelog</groupId>
  <artifactId>com.io7m.changelog.cmdline</artifactId>
  <version>4.0.0-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.changelog</groupId>
  <artifactId>com.io7m.changelog.core</artifactId>
  <version>4.0.0-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.changelog</groupId>
  <artifactId>com.io7m.changelog.documentation</artifactId>
  <version>4.0.0-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.changelog</groupId>
  <artifactId>com.io7m.changelog.schema</artifactId>
  <version>4.0.0-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.changelog</groupId>
  <artifactId>com.io7m.changelog.tests</artifactId>
  <version>4.0.0-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.changelog</groupId>
  <artifactId>com.io7m.changelog.xml.vanilla</artifactId>
  <version>4.0.0-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.changelog</groupId>
  <artifactId>com.io7m.changelog.xml.api</artifactId>
  <version>4.0.0-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.changelog</groupId>
  <artifactId>com.io7m.changelog.parser.api</artifactId>
  <version>4.0.0-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.changelog</groupId>
  <artifactId>com.io7m.changelog.text.api</artifactId>
  <version>4.0.0-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.changelog</groupId>
  <artifactId>com.io7m.changelog.writer.api</artifactId>
  <version>4.0.0-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.changelog</groupId>
  <artifactId>com.io7m.changelog.text.vanilla</artifactId>
  <version>4.0.0-SNAPSHOT</version>
</dependency>

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

Sources

This project uses Git to manage source code.

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

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

License

Copyright ⓒ 2018 Mark Raynsford <code@io7m.com> http://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.