Release guide

A guide to releasing new versions of the Android CardScan SDK.



The CardScan library is split into multiple android modules, each of which has its own binary .aar file is independently released. This guide covers the batch release process for releasing all of the modules at once with the same version number.


CardScan uses semantic versioning (MAJOR.MINOR.PATCH).

Releasing a new version

  1. 1.
    Create a new release on github to create a new release. This will automatically update the changelog, the file, and publish a release to maven central.
  2. 2.
    To view the status of the automatic release, view the latest github action.
  3. 3.
    To view the status of the repository in maven central, see the nexus repository manager.

Update documentation

Update the API Docs to reflect the new version.

(Optional) Installing to local maven

  • execute ./gradlew install from the root of the repository.