BUILD.md

Table of Contents

• Release workflow
  • Step 1: Pull request
  • Step 2: Release library in Github
  • Final Step
    • Checklist

Release workflow

The main goal of the build process is to publish the artifacts to public repository Maven Central.

Step 1: Pull request

Create a new PR for the new release:

• Increment the release version to the new library version, please follow the semantic versioning for finding the new version.
• Make sure all the dependencies are up-to-date everywhere in the documentation files and the project files where needed.
• Make sure to add a section for the release in the release notes.
• Ask for review for this PR and then "squash and merge" to master.

For example PR, see: #412

---

Step 2: Release library in Github

To release the library, you need to "create a new release" with Github, describe the new release as below and publish it.

For example, define the link to the release notes pointing to a released version:

#### 1.8.2
- [Release notes](https://github.com/commercetools/commercetools-sync-java/blob/master/docs/RELEASE_NOTES.md#182----april-30-2020)
- [Javadoc](https://commercetools.github.io/commercetools-sync-java/v/1.8.2/)

Additionally define important changes, breaking changes or important new features into the description.

The creation of a github release triggers a github action, which will deploy the library first to Sonatype staging repo and then to Maven Central.

Final Step

After the release build status is success ensure that the new version is publicly available at Maven Central.

Checklist

• Publish completed without an issue.
• The new version is available in the (https://repo1.maven.org/maven2/com/commercetools/commercetools-sync-java)