2. Branches

The firmware repo has 3 main branches:

• development
• release
• hotfix

Branch 'development'

Common properties:

Delete: no
Force push: yes
Direct merge or push commits without a pull request: yes

Pull requests into this branch:

From what branches: all
Require conversation resolution before merging: yes
Require approve form the number of reviewers: 0

This branch should be used for everyday work, developers can fork form it prepare their changes and merge commits to this branch or push directly. The development branch has its own pipelune build that creates artifatcs indicating current date and sequential build number. Build artifacts created from the development branch could be used for internal purposes like testing or self-running, but it's depricated to use them for public releases. Also, one can create a pull request from this branch to 'release', the pull request title must contain "RELEASE" sing, e.g. "[RELEASE] Implement recent changes for profile settings".

Branch 'release'

Common properties:

Delete: no
Force push: no
Direct merge or push commits without a pull request: no

Pull requests into this branch:

From what branches: 'development' or 'hotfix' only
Require conversation resolution before merging: yes
Require approve form the number of reviewers: 1

The release branch is used for preparing and creating release builds from the development branch. When some ammount of work is ready to be built as a release, a pull request should be created from 'development' to the 'release' branch. Pull requests to the 'release' branch are possible only from the 'development' or 'hotfix' branches. In case of creating the pull request from the 'development' branch, its title should include "RELEASE" text. For example: "[RELEASE] Implement recent changes for profile settings". For pull requests from the 'hotfix' branch, the pull request title should contain "HOTFIX" sign, like "[HOTFIX] Fix pedals calibration". If one uses a wrong branch for pulling into release or a wrong pull request title, the pull request pipeline workflow will fail witn an error. Additionally, pull requests into the 'release' branch could contain some extra checkings e.g. approval from reviewers, resolving all comments, and so on. After passing all checks, the pull request could be merged into 'release', and then a new pipeline (on push to 'release' event) will start. During this pipeline build, artifacts with indicating current date and release version number will be prepared. These artifacts can be used fo public releases. The 'release' branch could not be deleted or force pushed.

Branch 'hotfix'

Common properties:

Delete: no
Force push: no
Direct merge or push commits without a pull request: yes

Pull requests into this branch:

From what branches: all
Require conversation resolution before merging: yes
Require approve form the number of reviewers: 0

This branch is used only for quick fixes and the following pull request into the 'release' branch. The 'hotfix' branch doesn't have its own pipelines. In case of creating the pull request from the 'hotfix' branch into 'release', the PR title should include "HOTFIX" text. For example: "[HOTFIX] Fix pedals calibration".