Skip to content
GitLab

Release Checklist · Changes

Page history
Updated Release Checklist (markdown) authored by Jérémie Bresson's avatar Jérémie Bresson
Hide whitespace changes
Inline Side-by-side
Release-Checklist.md
View page @ bdb983ee
......@@ -3,17 +3,29 @@
- Review [milestones](https://github.com/openapitools/openapi-generator/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](https://github.com/swagger-api/swagger-codegen/pull/4889)), if needed
- File a PR: (e.g. [#280](https://github.com/OpenAPITools/openapi-generator/pull/280))
- to remove the SNAPSHOT version (script `bin/utils/release_version_update.sh` can be used, e.g. `bin/utils/release_version_upate 3.0.2-SNAPSHOT 3.0.2`)
- to update the OpenAPI Generator Online's Dockerfile to use the stable version
- 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
- update core, parser versions (e.g. [#4889](https://github.com/swagger-api/swagger-codegen/pull/4889)), if needed
- 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](https://github.com/OpenAPITools/openapi-generator/pull/285)). Script `bin/utils/release_version_update.sh` can be used. **Be careful** this script creates changes that need to be reverted.
......