Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Wiki
  • Release Checklist

Release Checklist · Changes

Page history
Updated Release Checklist (markdown) authored Jun 18, 2018 by Jérémie Bresson's avatar Jérémie Bresson
Show whitespace changes
Inline Side-by-side
Release-Checklist.md
View page @ 33dfcf5b
...@@ -9,15 +9,18 @@ ...@@ -9,15 +9,18 @@
- to update the OpenAPI Generator Online's Dockerfile to use the stable version. (script `bin/utils/release_version_update.sh` can be used) - 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. - 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 ## Release
- merge the "prepare PR" - merge the "prepare release" PR
- git tag the merged commit - git tag the merged commit
- publish the release notes - publish the release notes
CI: The CI (travis) will perform:
- push the JAR to maven repository (automatically done by the CI) - push the JAR to maven repository (automatically done by the CI)
- push the Docker images to DockerHub.com (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: ### Input for the Release notes:
...@@ -26,14 +29,32 @@ CI: ...@@ -26,14 +29,32 @@ CI:
Draft release in GitHub can be used for internal review with the team. 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 ## 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. * File a PR "Prepare next snapshot version":
- re-enable bin/ensure-up-to-date and update the Petstore samples accordingly - 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.
- update README (e.g. [167b2f5](https://github.com/openapitools/openapi-generator/commit/167b2f59b811ba6780976a6e6764c1edf75a30f7), [1029b69](https://github.com/openapitools/openapi-generator/commit/1029b692e5fcfc2600433a85613ba42e2646826d)) - re-enable bin/ensure-up-to-date and update the Petstore samples accordingly
- update OpenAPI Generator Maven Plugin README (modules/openapi-generator-maven-plugin/README.md) (e.g. [9c79297]( https://github.com/openapitools/openapi-generator/commit/9c79297d6a073790a90b6efedd32e8bebd177828)) - update README (e.g. [167b2f5](https://github.com/openapitools/openapi-generator/commit/167b2f59b811ba6780976a6e6764c1edf75a30f7), [1029b69](https://github.com/openapitools/openapi-generator/commit/1029b692e5fcfc2600433a85613ba42e2646826d))
- update Homebrew formula to use the latest version, e.g. https://github.com/Homebrew/homebrew-core/pull/28921 - update OpenAPI Generator Maven Plugin README (modules/openapi-generator-maven-plugin/README.md) (e.g. [9c79297]( https://github.com/openapitools/openapi-generator/commit/9c79297d6a073790a90b6efedd32e8bebd177828))
- ~~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 Homebrew formula to use the latest version, e.g. https://github.com/Homebrew/homebrew-core/pull/28921
- update [milestones](https://github.com/openapitools/openapi-generator/milestones) * ~~update https://generator.swagger.io to run the latest version of OpenAPI Generator~~
- use Twitter account "oas_generator" to announce the new release * update [milestones](https://github.com/openapitools/openapi-generator/milestones)
\ No newline at end of file
* Announcements:
- use Twitter account "oas_generator" to announce the new release
- gitter channel
\ No newline at end of file
Clone repository
  • API client generator HOWTO
  • Building your own Templates
  • Customizing client code generation
  • FAQ
  • Git Branches
  • Home
  • How to add a generator for a new language or framework
  • Integration Tests
  • Migration Guide
  • Mustache Template Variables
  • Pull Request Checklist
  • Release Checklist
  • Samples folder
  • Server stub generator HOWTO
  • Vendor Extensions
View All Pages