Skip to content

Octo-App(itizers): Utilities for building GitHub Apps

License

Notifications You must be signed in to change notification settings

StarChart-Labs/calamari

Repository files navigation

Calamari

GitHub Actions codecov Black Duck Security Risk Changelog validated by Chronicler

Octo-App(itizers): Utilities for building GitHub Apps

Compatibility

Major Version Migrations

For steps to migrate between major versions of Calamari, see the migration guide

Using Versions 0.3.0 or Older

Calamari is available on JCenter and Maven Central, but requires the BouncyCastle library for certain operations.

In versions 0.3.0 and older, Calamari used a security patch of these libraries, which required that consuming projects also allow https://maven.repository.redhat.com/ga/ as a maven repository source in build configuration

Contributing

Information for how to contribute to Calamari can be found in the contribution guidelines

Legal

Calamari is distributed under the MIT License. There are no requirements for using it in your own project (a line in a NOTICES file is appreciated but not necessary for use)

The requirement for a copy of the license being included in distributions is fulfilled by a copy of the LICENSE file being included in constructed JAR archives

Reporting Vulnerabilities

If you discover a security vulnerability, contact the development team by e-mail at vulnerabilities@starchartlabs.org

Projects

calamari-core

Maven Central

Contains utilities for operations expected to be necessary for the vast majority of GitHub App implementations, such as authentication