OperatorFabric CICD

On the operatorfabric-core repository, create a branch off the develop branch named X.X.release if it does not exist (note the lowercase release to distinguish it from X.X.X.RELEASE tags).

git checkout -b X.X.release
git push --set-upstream origin X.X.release

git checkout -b FE-X.X.X-RC.release.draft

Use the ./CICD/prepare_release_version.sh script to automatically perform all the necessary changes:

./CICD/prepare_release_version.sh -v X.X.X-RC.RELEASE

Current version is SNAPSHOT (based on VERSION file)
Preparing X.X.X-RC.RELEASE
Updating version for pipeline in VERSION file
Replacing SNAPSHOT with X.X.X-RC.RELEASE in swagger.yaml files
Using X.X.X-RC.RELEASE for lfeoperatorfabric images in dev and docker environment docker-compose files
The following files have been updated:
 M VERSION
 M config/dev/docker-compose.yml
 M config/docker/docker-compose.yml
 M services/cards-publication/src/main/modeling/swagger.yaml
 M services/businessconfig/src/main/modeling/swagger.yaml
 M services/users/src/main/modeling/swagger.yaml

Commit the changes with the template message:

git add .
git commit -s -m "[RELEASE] X.X.X-RC.RELEASE"

Push the commit

git push --set-upstream origin X.X.X-RC.release.draft

Create a pull request from the X.X.X-RC.release.draft branch to the X.X.release branch and ask for a review.

Once the pull request is approved and merge, create the tag for the release candidate:

git checkout X.X.release
git pull
git tag X.X.X-RC.RELEASE
git push origin X.X.X-RC.RELEASE

Set the appropriate properties (credentials and GPG key information) as described in the documentation for the publishing task

Run the following command from the project root on the release branch:

./gradlew publish

After a while you should be prompted to enter the passphrase for the GPG key.

Once the task has completed, log in to the OSSRH Repository using the same credentials as for the Sonatype JIRA.

Click on Staging repositories link on the left. After a while (and maybe after clicking the refresh button), you should see a repository with the name orgopfab-XXXX (where XXXX is a Sonatype-generated id, not related to the release number).

Click on the repository then on the "content" tab below to check its content and metadata.

If there is an issue with the repository, click on the "Drop" button and start the process again after making the necessary changes. If everything looks in order, click on the "Close" button and add a small comment when prompted to confirm.

This will trigger validation of the Sonatype requirements (for example, making sure that the pom file contains the required information), as you can see from the Activity tab below (Refresh might be needed).

If all the validations pass, the "Release" button will become available. Click it to send the jars to Maven Central. When prompted, write a comment then confirm (keeping the "Automatically Drop" option checked).

The jars for the release should then be available on the project space in the Maven repository within 10 minutes.

It can take up to two hours for them to appear on the Maven Central Repository Search and up to one day for MvnRepository

On the releases screen for the core repository, draft a new release.

Create a new release_notes.Y.Y.Y.md file with next version number.

Create a branch to prepare the release from the release candidate branch:

git checkout X.X.release
git checkout -b X.X.X.release.draft

Use the ./CICD/prepare_release_version.sh script to automatically perform all the necessary changes:

./CICD/prepare_release_version.sh -v X.X.X.RELEASE

Current version is SNAPSHOT (based on VERSION file)
Preparing X.X.X.RELEASE
Updating version for pipeline in VERSION file
Replacing SNAPSHOT with X.X.X.RELEASE in swagger.yaml files
Using X.X.X.RELEASE for lfeoperatorfabric images in dev and docker environment docker-compose files
The following files have been updated:
 M VERSION
 M config/dev/docker-compose.yml
 M config/docker/docker-compose.yml
 M services/cards-publication/src/main/modeling/swagger.yaml
 M services/businessconfig/src/main/modeling/swagger.yaml
 M services/users/src/main/modeling/swagger.yaml

Commit the changes with the template message:

git add .
git commit -s -m "[RELEASE] X.X.X.RELEASE"

Push the commit

git push --set-upstream origin X.X.X.release.draft

Create a pull request from the 'X.X.X.release.draft` branch to the X.X.release branch and ask for a review.

Once the pull request is approved and merge, create the tag for the release candidate:

git checkout X.X.release
git pull
git tag X.X.X.RELEASE
git push origin X.X.X.RELEASE

Check that the X.X.X.RELEASE images have been generated and pushed to DockerHub.

Check that the latest images have been updated on DockerHub (if this has been triggered).

Check that the documentation has been generated and pushed to the GitHub pages website : check the version and revision date at the top of the documents in the current documentation (for example the architecture documentation)

Check that the tag was correctly pushed to GitHub and is visible under the tags page for the repository.

Add the version being released to the list with the current badge

Remove the current badge from the previous version

Remove your locally built X.X.X.RELEASE images if any

Run the config/docker docker-compose file to make sure it pulls the images from DockerHub and behaves as intended.

On the releases screen for the core repository, draft a new release.