Skip to content

JDBC Connector Release Process


Location Usage
Maven Central egeria-connector-resource-jdbc
Maven Central egeria-connector-integration-jdbc docker pull
Docker Hub docker pull odpi/egeria-connector-jdbc:TAGNAME
Github source code in zip and tar.gz formats or via git checkout vx.y to get version as-shipped (each release is tagged at the point it is shipped)

Release process

1. Release cycle

JDBC connector release cycle is not necessarily synced with Egeria core release. The community will create new release when there is major Egeria core change or new important enhancement is contributed to the connector.

2. Track remaining issues and PRs

Aim to branch when most issues / PRs are complete to minimize back-porting from main, but not at the expense of impacting ongoing main development

3. Create release branch
  • Checkout main git checkout main
  • Ensure local update git fetch upstream, git merge upstream/main (or git reset --hard upstream/main), git pull --no-rebase
  • Create branch git branch release-x.y
  • Push to upstream git push upstream release-x.y
  • Pull upstream git pull upstream release-x.y
4. Update release-x.y from x.y-SNAPSHOT to x.y
  • git checkout release-x.y
  • Edit the build.gradle files (command line or IDE) to replace x.y-SNAPSHOT with the same non-snapshot version x.y, e.g. change 4.0-SNAPSHOT to 4.0.
  • If using an IDE like IntelliJ, make sure you have all hits by searching again as by default only a limited number of hits are shown .
  • Make sure you are using stable compatible Egeria implementation version as a dependency
  • Check if you are using latest versions for third party dependencies
  • Add the changes and commit git commit -s
  • Create a PR, have reviewed / approved and merged as usual - aim to do this as quickly as reasonable so that there is no potential for version clash
5. Test, merge any remaining required changes into branch
  • Run appropriate tests for the release. For example, in addition to automated build tests:
    • Run functional and regression test
    • If applicable, run the CTS and check that all profiles are compliant
    • If infrastructure exists, run the PTS and check that there are no unexpected performance regressions.
  • Raise issues for any changes required as usual.
    • If there are any issues, delete the release-x.y branch, fix in main branch, and repeat steps (3-4) until no remaining issues.
6. Release artifacts publishing
  • Build and publish release version by selecting the release branch and executing Release action.
  • Review and release artifacts as explained in the Maven Publishing Guide.
  • Check if all maven artifacts are available in maven central repository (it will take some time to sync)
  • Check if new docker containers are created under the different docker repositories respectively.
7. Update mains release version from x.y-SNAPSHOT to x.z-SNAPSHOT
  • git checkout main
  • Ensure local update git fetch upstream, git merge upstream/main, git pull --no-rebase
  • Edit build.gradle (command line or IDE) to replace x.y-SNAPSHOT with x.z-SNAPSHOT.
  • Commit, and do not make any other changes.
  • Create a PR, have reviewed / approved and merged as usual
8. Create a release in GitHub and notify the community
  • Create the GitHub release . Use vx.y as the tag, and ensure the correct branch is set for the target, i.e. release-x.y
  • Fill in the release notes using a short title summarizing the primary changes in the release and in the description outline the changes across new features, bug fixes, security fixes, any repository migration required, and minimum version of Egeria against which the connector should be used
  • Source archives will be added to the release on GitHub.
  • Notify the community on Slack or email channels.
  • Optionally add entry to the monthly newsletter.

Raise an issue or comment below