Maintenance Guides
Release procedure
- Create a branch dedicated to the current release.
- Check
gradle.properties
file:- Check the consistency of the version.
- Check
build.gradle.kts
file:- Use only released dependencies.
- Upgrade Keyple dependencies to their latest released versions.
- Update
CHANGELOG.md
file:- Verify the consistency of the
Unreleased
section. - Move content of
Unreleased
section to a new “release” section. - Update bottom links.
- Build and test the component.
- Commit the modified files using if possible the commit message
Release x.y.z
. - Push and create a pull request to merge the branch into
main
. - Await the success of the build by the CI.
- Squash and merge the pull request.
- Await the success of the build by the CI.
- Create a release on GitHub:
- Set tag
x.y.z
- Set release name
x.y.z
- Set the content by copying/pasting the content of the current release description in the
CHANGELOG.md
file without the bottom links.
- Await the success of the build by the CI.
- Connect to Nexus Repository Manager of Calypsonet and go to “Staging Repositories” page:
- Select the correct folder to Close & Release. It must contain the manifests, the JAR and all the others elements (sources, javadoc).
- Close the folder.
- Release the folder.
- The other unwanted folders could be dropped.
- Check the availability of the release on the Maven Repository. This step may take from 10 minutes to 2 hours.
- Update this website:
- Update version in
params.yaml
file. - Update others elements if needed.
- Commit and push the modifications.
Last updated on 2021-12-17