com.io7m.scando

scando

A trivial command-line wrapper around japicmp.

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.

Building

$ mvn clean verify

Usage

Usage: scando [options] Options: --excludeList A file containing a list of package/class exclusions --help Display this help message * --htmlReport The output file for the HTML report --ignoreMissingOld Trivially succeed if the old jar is missing. Default: false * --newJar The new jar file * --newJarVersion The new jar version * --oldJarUri The old jar/aar file/URI * --oldJarVersion The old jar version * --textReport The output file for the plain text report $ java -jar \ com.io7m.scando.cmdline-0.0.1-main.jar \ --oldJarUri https://repo1.maven.org/maven2/com/io7m/jtensors/io7m-jtensors-core/7.1.0/io7m-jtensors-core-7.1.0.jar \ --newJar com.io7m.jtensors.core-9.0.0.jar \ --oldJarVersion 7.1.0 \ --newJarVersion 7.2.0 \ --textReport report.txt \ --htmlReport report.html INFO: Text report written to report.txt INFO: HTML report written to report.html ERROR: Version change between 7.1.0 and 7.2.0 is MINOR, but the changes made to code require a MAJOR version change $ echo $? 1

The --excludeListparameter, 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.

Releases & Development Snapshots

Releases

You can subscribe to the atom feed to be notified of project releases.

The most recently released version of the package is 1.0.0.

1.0.0 Release (2023-08-22Z)

• Initial release.

The compiled artifacts for the release (and all previous releases) are available on Maven Central.

Maven Modules

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

Previous Releases

The changelogs for the most recent previous releases are as follows:

0.0.5 Release (2020-09-22Z)

• Add support for downloading jar/aar files. (Backwards incompatible)

0.0.4 Release (2020-06-26Z)

• Add support for Android aar files (Tickets: 1)

Development Snapshots

At the time of writing, the current unstable development version of the package is 1.0.1-SNAPSHOT.

Development snapshots may be available in the Central Portal Snapshots repository. Snapshots are published to this repository every time the project is built by the project's continuous integration system, but snapshots do expire after around ninety days and so may or may not be available depending on when a build of the package was last triggered.

Manual

This project does not have any user manuals or other documentation beyond what might be present on the page above.

Sources

This project uses Git to manage source code.

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

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

Issues

This project uses GitHub Issues to track issues.

License

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