Release Process

Releasing a new version

splunk-otel-android is released via a private Splunk gitlab installation.

This is the process to use to do a release:

Make sure that all the required changes are merged. This includes updating the upstream OTel libraries' versions, and making sure that the project version in the gradle.properties file is correctly set to the next planned release version.
Run the scripts/tag-release.sh script to create and push a signed release tag. Note that it assumes that the remote is named origin, if you named yours differently you might have to push the tag manually.
Wait for gitlab to run the release job. If all goes well, it will automatically close and release the "staging" repository...which means the build has been published to sonatype and will appear in maven with in a day or two at most (typically a few hours).
Create a PR to update the version in the gradle.properties to the next development version. This PR can and probably should also include updating any documentation (CHANGELOG.md, README.md, etc) that mentions the previous version. Make sure the badge in the top README.md reflects the accurate upstream otel version.
Once this PR is merged, create a release in Github that points at the newly created version, and make sure to provide release notes that at least mirror the contents of the CHANGELOG.md