Skip to content

ConfigRelease

Jump to bottom
jclingan edited this page Feb 28, 2024 · 1 revision

How to perform a release

The following process applies to any release, including milestones, release candidates and final. I have not got it working on Windows. Other OS is fine.

  1. Prepare the release
    1. Clone the MicroProfile Config master repository
    2. Run the prepare_release.sh script (specify required env vars before) - it should create a tag and push it to the upstream repository
      1. export RELEASE_VERSION=1.0-RC3
      2. export DEV_VERSION=1.0-SNAPSHOT
      3. export GIT_USER='John Doe'
      4. export GIT_EMAIL='[email protected]'
  2. Deploy artifacts into Eclipse repository
    1. Logon to Jenkins (register for an account if you don't have a Jenkins account)
    2. Go to https://ci.eclipse.org/microprofile/job/CONFIG-deploy-prerelease-artifacts/ and then click on "Build with Parameters"
  3. Download the PDF document from the Jenkins job and from in the workspace and copy it to github release page (this step could be removed if we release it to a maven repo)
  4. Notify MicroProfile community about the new version
    1. Send information about the created tag and artifact to review the release, e.g. on mailing-list
      1. Git tag is in the source repository
      2. artifacts (API, TCK, PDF?) are in the Eclipse repository

How to perform a release of a final version

Do the steps above for a release candidate, except increase the development version instead of leaving it the same as before

If a release candidate is approved, it can be turned into final

  1. Run the above steps for the final version, but:
    1. set BASE_REVISION variable to the name of the release candidate tag
    2. increase DEV_VERSION to point to the next snapshot version
  2. Publish the final artifact to Maven central - follow instructions in the script deploy_to_maven_central.sh
  3. announce the final version
  4. increase the snapshot version in master: merge the intermediary branch branch_$RELEASE_VERSION created locally by the script to master and push master:
    1. git checkout master
    2. git merge branch_$RELEASE_VERSION
    3. git push origin master

Category:MicroProfile

Clone this wiki locally