README.md

CircleCI Maven Release Orb

A CircleCI Orb than can be used to deploy maven projects using the maven-release-plugin.

Click the orb version badge above for usage examples and documentation.

How to use the Maven Release Orb in your config.yml

There are a number of examples in the Orb documentation (see the Example source code).

The simplest example of a CircleCI config.yml file is duplicated below:

  version: 2.1

  orbs:
    circleci-maven-release-orb: sonatype-nexus-community/circleci-maven-release-orb@x.y.z

  workflows:
    main:
      jobs:
        - circleci-maven-release-orb/run-maven-release

You would replace x.y.z with a real version. To use the latest development version of the Orb, replace x.y.z with dev:alpha.

While experimenting with this plugin, you should use the Dry Run example to avoid creating a bunch of spurious releases.

The Orb Description section documents additional requirements for using this Orb.

The Fine Print

It is worth noting that this is NOT SUPPORTED by Sonatype, and is a contribution of ours to the open source community (read: you!)

Don't worry, using this community item does not "void your warranty". In a worst case scenario, you may be asked by the Sonatype Support team to remove the community item in order to determine the root cause of any issues.

Remember:

• Use this contribution at the risk tolerance that you have
• Do NOT file Sonatype support tickets related to Orb support
• DO file issues here on GitHub, so that the community can pitch in

Phew, that was easier than I thought. Last but not least of all:

Have fun creating and using this Orb, we are glad to have you here!

Getting help

Looking to contribute to our code but need some help? There's a few ways to get information:

• Chat with us on Gitter
• See the community: CircleCI Discuss badge at the top of this page.