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

Release

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

CI:

• push the JAR to maven repository (automatically done by the CI)
• push the Docker images to DockerHub.com (automatically done by the 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.

After Release

• 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/28921
• update https://generator.swagger.io to run the latest version of OpenAPI Generator
• add tag (e.g. 2.3.0) to docker image in Docker Hub (done automatically by CI)
• update milestones
• use Twitter account "oas_generator" to announce the new release