This issue is to document the release workflow in the developer documentation. At the core of the release workflow, the GitFlow release model has been adopted. Once the develop branch has acquired enough features for a release (or a predetermined release date is approaching), a release branch should be forked off of develop. This branch should only contain bug fixes, documentation generation, and other release-oriented tasks. Once it's ready to ship, the release branch gets merged into main and tagged with a version number. In addition, it should be merged back into develop, which may have progressed since the release was initiated. This general workflow with all details and explanations will be documented.
Using a dedicated branch to prepare releases makes it possible for one team to polish the current release while another team continues working on features for the next release.
Description
This issue is to document the release workflow in the developer documentation. At the core of the release workflow, the GitFlow release model has been adopted. Once the
develop
branch has acquired enough features for a release (or a predetermined release date is approaching), a release branch should be forked off ofdevelop
. This branch should only contain bug fixes, documentation generation, and other release-oriented tasks. Once it's ready to ship, the release branch gets merged intomain
and tagged with a version number. In addition, it should be merged back intodevelop
, which may have progressed since the release was initiated. This general workflow with all details and explanations will be documented.Checklist
Additional Information [source]
develop
branch.