Release Checklist

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. For issues, here are the steps:

  • Go to the issue tracker
  • Click on the drop-down menu "Milestones" and select 3.0.2 (current milestone)
  • After the page loading completes (which show all issues for the milestone 3.0.2), click on the checkbox next to the issue counter (right below Clear current search query, filters, and sorts) to select all issues in the current page
  • Click again on the drop-down menu "Milestones" to change the milestones of these selected issues to 3.0.3
  • Repeat until all issues have been updated with the new milestones
  • (the same procedure can be applied to updating the PR's milestone)

• 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:

• Check DockerHub:
  • https://hub.docker.com/r/openapitools/openapi-generator-cli/tags/
  • https://hub.docker.com/r/openapitools/openapi-generator-online/tags/
• Check maven central:
  • Run a small maven project using the openapi-generator-maven-plugin central plugin
  • Run a small gradle project: modules/openapi-generator-gradle-plugin/samples/local-spec, according to the README.md there, do some test with -PopenApiGeneratorVersion=<version>

After Release

• File a PR "Prepare next snapshot version":

  • update versions to next SNAPSHOT version (e.g. #285). Script bin/utils/release_version_update.sh can be used. Be careful this script creates changes that need to be reverted.
  • re-enable bin/ensure-up-to-date and update the Petstore samples accordingly
  • update README (e.g. 167b2f5, 1029b69)
  • update OpenAPI Generator Maven Plugin README (modules/openapi-generator-maven-plugin/README.md) (e.g. 9c79297)

• update Homebrew formula to use the latest version, e.g. https://github.com/Homebrew/homebrew-core/pull/29164/commits/21c808cf733d42581e1a4a096828c1996ca314e2

• update https://generator.swagger.io to run the latest version of OpenAPI Generator

• update milestones

• Announcements:

  • use Twitter account "oas_generator" to announce the new release
  • gitter channel