Project icon

com.io7m.scando

Build status Maven Central Codecov

The scando package implements a jar version checker. It essentially provides a wrapper around the japicmp API that does one thing: Checks to see if you have incremented version numbers in accordance with semantic versioning rules.

Contents

Features

  • Simple command-line tool for checking jar version changes.
  • Compare jar files for semantic versioning conformance.
  • Compare Android aar files for semantic versioning conformance.
  • Powered by japicmp.
  • High-coverage automated test suite.
  • ISC license

Releases

The most recently published version of the software is 1.0.0.

Source code and binaries are available from the repository.

Documentation

Documentation for the 1.0.0 release is available for reading online.

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

User documentation

The --excludeList parameter, if specified, gives the path of a file containing one exclude pattern per line. Empty lines, and lines starting with # are ignored. See japicmp for the syntax of exclude patterns.

The --ignoreMissingOld parameter, if specified, allows for ignoring a missing "old" jar. This is useful when, for example, a new module is added to a project.

Maven

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

<dependency>
  <groupId>com.io7m.scando</groupId>
  <artifactId>com.io7m.scando</artifactId>
  <version>1.0.0</version>
</dependency>

<dependency>
  <groupId>com.io7m.scando</groupId>
  <artifactId>com.io7m.scando.cmdline</artifactId>
  <version>1.0.0</version>
</dependency>

<dependency>
  <groupId>com.io7m.scando</groupId>
  <artifactId>com.io7m.scando.tests</artifactId>
  <version>1.0.0</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.

2023-08-22 Release: com.io7m.scando 1.0.0
2023-08-22 Change: Initial release.
2020-09-22 Release: com.io7m.scando 0.0.5
2020-09-22 Change: (Backwards incompatible) Add support for downloading jar/aar files.
2020-06-26 Release: com.io7m.scando 0.0.4
2020-06-26 Change: Add support for Android aar files (tickets: 1 )

Sources

This project uses Git to manage source code.

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

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

License

Copyright © 2022 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.