Skip to content

Release Checklist

Jump to bottom Edit New page
William Cheng edited this page Jun 18, 2018 · 35 revisions

Before Release

  • Review milestones to ensure there are no outstanding issues/PRs that need to be urgently addressed before the release.

  • Create the next milestone (e.g. 3.0.3 if the current version if 3.0.2-SNAPSHOT)

  • Update open PRs, issues of the current milestone (e.g. 3.0.2) to the next milestone (3.0.3)

  • update dependencies if needed (core, parser versions...) (e.g. #4889), if needed

  • File a PR: (e.g. #280)

    • to remove the SNAPSHOT version (script bin/utils/release_version_update.sh can be used, e.g. bin/utils/release_version_update.sh 3.0.2-SNAPSHOT 3.0.2)
    • to update the OpenAPI Generator Online's Dockerfile to use the stable version. (script bin/utils/release_version_update.sh can be used)
    • to disable bin/ensure-up-to-date.sh in shippable for the time being.

  • Add a quick announcement on the Gitter channel (one day before)

Release

  • merge the "prepare release" PR
  • git tag the merged commit
  • publish the release notes

The CI (travis) will perform:

  • push the JAR to maven repository (automatically done by the CI)
  • push the Docker images to DockerHub.com (automatically done by the CI)
  • add tag (e.g. 2.3.0) to docker image in Docker Hub (done automatically by CI)

Input for the Release notes:

  • use the same format (e.g. ## General)
  • for PRs related to generators, sort them alphabetically

Draft release in GitHub can be used for internal review with the team.

Checks

Check status of the tag build on travis CI.

Tests:

After Release

Add a custom footer
Add a custom sidebar
Clone this wiki locally