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
Document using new release versioning scripts. authored Jun 24, 2019 by Jim Schubert's avatar Jim Schubert
Show whitespace changes
Inline Side-by-side
Release-Checklist.md
View page @ 7024d560
......@@ -14,10 +14,12 @@
- Click 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 -- in case of multiple pages)
- File a PR: (e.g. [#280](https://github.com/OpenAPITools/openapi-generator/pull/280), [#588](https://github.com/OpenAPITools/openapi-generator/pull/588))
- Set the correct 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 remove the SNAPSHOT version
- to update the OpenAPI Generator Online's Dockerfile to use the stable version.
- mention the coming release in the docs (`bin/utils/release_version_update_docs.sh 3.0.2 3.0.3` can be used -- example commit [9056c1e5e3](https://github.com/OpenAPITools/openapi-generator/pull/588/commits/9056c1e5e3f8bac515e676a4d8ebed0f0d4dc85b)):
- Set the correct version by executing `bin/utils/release/release_version_update.sh` with the target version increment (`major`, `minor`, `build`, or `snapshot`). Example:
```bin/utils/release/release_version_update.sh build```
- mention the coming release in the docs. `bin/utils/release/release_version_update_docs.sh` accepts a version and the increment. Example:
```bin/utils/release/release_version_update_docs.sh 3.0.2 build` ```
See commit [9056c1e5e3](https://github.com/OpenAPITools/openapi-generator/pull/588/commits/9056c1e5e3f8bac515e676a4d8ebed0f0d4dc85b))
- Verify or modify the updated values accordingly
- update root `README.md`: (e.g. [167b2f5](https://github.com/openapitools/openapi-generator/commit/167b2f59b811ba6780976a6e6764c1edf75a30f7), [1029b69](https://github.com/openapitools/openapi-generator/commit/1029b692e5fcfc2600433a85613ba42e2646826d))
- Update the release table
- mention the last released version in Section "1.3 - Download JAR"
......@@ -80,7 +82,7 @@ Checking openapi-generator-cli docker ... [OK]
## After Release
* File a PR "Prepare next snapshot version":
- 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 versions to next SNAPSHOT version (e.g. [#285](https://github.com/OpenAPITools/openapi-generator/pull/285)). Script `bin/utils/release/release_version_update.sh snapshot` can be used. **Be careful** this script may create changes that need to be reverted. Verify the output after running.
* update Homebrew formula to use the latest version, e.g. https://github.com/Homebrew/homebrew-core/pull/29164/commits/21c808cf733d42581e1a4a096828c1996ca314e2
* close the released milestone (see [milestones](https://github.com/openapitools/openapi-generator/milestones) view)
* after the JAR has been published to the Maven repo, update "openapi-generator-cli"
......
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