README.md

Credential Issuer common libraries

A library of common functions that can be used across credential issuers for validation, event transmission, describing common data etc.

Publishing to Maven Central

To publish a new version to Maven Central, follow these steps:

1. Bump the version
   Create a pull request that updates the buildVersion in build.gradle.

2. Merge the PR
   Once approved, merge the pull request into the main branch.

3. Create a new GitHub release
   Go to Create new release and:

   • Set the tag name to match the version from build.gradle, prefixed with v (e.g. v1.0.0)
   • Use the same value for the release title (e.g. v1.0.0)
   • Click "Generate release notes" and edit them for clarity and readability
   • Click "Publish release"

4. Trigger the Maven publish action
   Publishing will start automatically via the Publish to Maven Central GitHub Action.

5. Verify the release
   It may take up to 15 minutes for the new version to appear on Maven Central.

Testing changes locally with a development CRI stack

To test changes made to this repository with a development CRI stack you must follow the steps below to publish to mavenLocal:

Within this repository:

1. Update buildVersion in build.gradle to the next version to avoid version conflicts
2. Comment out signAllPublications() within the mavenPublishing block
3. Run the command: ./gradlew publishMavenPublicationToMavenLocal

In your cri repo:

1. Update the version used for cri_common_lib to the same version set above in build.gradle
2. Add mavenLocal() to the repositories sections in build.gradle. Note: This may need to be done in multiple places depending on the CRI project setup.

You should now be able to build your CRI stack and deploy to AWS with your local cri_common_lib changes.