search

adobe / aio-lib-java-cloudmanager

Java wrapper to the Adobe Cloud Manager API.
https://opensource.adobe.com/aio-lib-java-cloudmanager/
Apache License 2.0
3 stars 9 forks source link

readme

Maven Central Build Codecov License

Adobe I/O Java Cloud Manager Library

This is a Java Library wrapping the Adobe Cloud Manager API.

Goals

Provide a set of convenience methods for interacting with the Cloud Manager definitions for a given organization.

Usage

See the docs.

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Please run the and include the output from the generate-javadoc Maven profile for any Pull Requests, to keep the documentation up-to-date.

GitHub Actions

Tag & Release

This is the only action that requires a user to activate manually.

Releasing a version of the library can be done by activating the Tag & Release action.

The version is optional, if unspecified it will use whatever Maven determines is the next release.

Snapshot Deploy

Activated on every commit to the main branch.

Automatically deploy a SNAPSHOT of the current build to Maven Central's snapshot repository.

Build & Verify

Activated on every pull request to the main branch.

Automatically run a build and tests for the project.

Update Changelog

Activated on every commit to the main branch.

This will automatically update the Changelog from Pull Requests or Issues, and commit it back to the main branch.

Update JavaDoc

Activated after every successful Tag & Release run. This will run the Maven profile for generating the Project JavaDocs and commit them back to the main branch. This will keep them always up-to-date with the latest release.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.

Developing

Updating API

If there's an update to the Cloud Manager swagger main API or Event API, then new models need to be generated.

The Event API is fetched directly from Github. However, the rest of the API has been modified slightly from the GitHub source. To update, replace the API's yaml file with the GitHub source, but ensure to keep these changes:

When ready to generate the new classes, run:


> mvn clean generate-sources -Pgenerate-api-model

Review the changes and commit them. There may be some trivial in the imports, as Swagger will make changes to the generated classes files. But a thorough review should still be done to ensure nothing unexpected has changed.