valitydev/openapi-generator
14
0
Fork 0
mirror of https://github.com/valitydev/openapi-generator.git synced 2024-11-06 10:35:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
a1fc114efa
openapi-generator/docs/release-summary.md
Jim Schubert 6fe9a52229 [feat][docs][website] Initial docusaurus based site (#1770) 
* Iniital docusaurus based site

* Remove error about default local being used by String.format

* Change pinned users to represent global presence rather than alphabetical order pinning

* Include generator indexes in ensure-up-to-date (docusaurus site and /generators/README)

* Add Font Awesome attribution footer

* Remove feature callout until it is completed

* Include NPM try it out section

* Improve "Getting Started" type docs

* Include new custom template documentation

* Updating templating and customization docs

* Add vendor extension docs

* Cleanup templating page(s).

* Move users to yaml file for easy edit.

* travis configuration, and baseUrl mods to image URLs

* [docs] Migrate FAQ, release summary  from wiki

FAQ has been split into multiple smaller documents to better categorize
and allow users to find what they're looking for (in docs folder or in
new website).

Release summary information (versioning strategy and cadence) has been
migrated from the Wiki and clarified a bit.

Also adds copy button for all code snippets in website.

* Copy current contributing/code of conduct to website

* [docs] Creating a new generator
2019-01-18 17:39:33 +08:00

1.4 KiB
Raw Blame History

id title
release-summary Release Summary

Versioning

We version artifacts in the common major.minor.patch strategy.

We decided versions should be incremented according to the following rules. The examples provided below are not exhaustive.

Part Breaking Changes? Rule Examples
major YES breaking changes without fallback
  • New Features
  • Large refactors
  • Removal of deprecated code
  • Changes to coding interfaces
  • Large changes to template bound variables
minor ALLOWED breaking changes with fallback
  • Adding new generator behavior which doesn't affect custom templates (or does, with config option for old behavior)
  • Changing generator templates in a way in which switching to custom templates results in old behavior
  • Introducing deprecated methods in generators or other shared code
patch NO new features without breaking changes
  • New generators
  • Bug fixes in template or generators

Cadence

For patch release (e.g. 3.0.5 to 3.0.6), we plan to do it on a weekly basis.

For minor release (e.g. 3.1.6 to 3.2.0), we plan to do it on a monthly basis.

For major releases (e.g. 3.3.6 to 4.0.0), we plan to do it on a quarterly basis.