Git Branches

The OpenAPI Generator project works on multiple versions in parallel:

Branches

To support several versions, several branches are used:

Status in June 2018:

To port changes from one branch to an other, the merge direction is always from the lowest version to the newer.

Example:

Those merge commits are done regularly by the core team.

Merge commit is kept in the history in order to facilitate merge conflict resolution.

When we want to jump on the next version, the working branch is merged back:

Example (end of June 2018):

When we drop the support for 3.0.x, we'll merge 3.1.x back into master:
- There will be one last 3.0.x release : 3.0.3 (orange commit)
- Then we merge 3.1.x into master, on the master branch the version is updated to 3.1.0-SNAPSHOT
- The master branch is now use to do the next 3.1.0 release and then weekly bugfix releases: 3.1.1, 3.1.2 ...
- We can create the 3.2.x branch to work on the next minor release 3.2.0-SNAPSHOT

Be careful of the merge direction. Keep merge commits as part of the history (no squash, ...).

Example for master -> 3.1.x branch:

git fetch
git checkout origin/3.1.x -B 3.1.x
git merge origin/master

Review the merge commit. You can run some checks locally mvn clean verify, bin/utils/ensure-up-to-date...

git push

TODO, add useful git command, inspired by the discussion in https://github.com/OpenAPITools/openapi-generator/issues/245

Edit the if condition in the .travis.yml file to allow the working branches to do a mvn deploy of the artifacts
Set it as protected branch in the GitHub configs
Update readme (branch list, badges…)