matthias/mayan-edms
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update git branches section

Browse Source 
Signed-off-by: Roberto Rosario <roberto.rosario@mayan-edms.com>
This commit is contained in:
Roberto Rosario
2019-09-11 19:27:07 -04:00
parent f7789fa6da
commit 03c63bcf80
1 changed files with 25 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/chapters/development.rst
View File

@@ -226,32 +226,46 @@ Git branch structure
Mayan EDMS follows a simplified model layout based on Vincent Driessen's Mayan EDMS follows a simplified model layout based on Vincent Driessen's
`Successful Git Branching Model`_ blog post. `Successful Git Branching Model`_ blog post.
``development`` ``/versions/micro``
The "next release" branch, likely unstable, don't use in production. Working branch for the next bugfix release. Micro increment (third digit).
Only bug fixes, minor features, back-ported urgent features. This
branch is stable and safe for production.
``/versions/minor``
Working branch for the next minor release (second digit). New features,
occasional breakage. Not for production but should run in test
environment most of the time. This is the branch you will want to
try out if you want to check out new features.
``/versions/major``
Working branch for the next major release (first digit). New features,
incompatible changes to the user facing interfaces. Broken most of the
time, not for production and should only be cloned by developers
with experience with Mayan's development.
``master`` ``master``
Current production release (|version|). Points to the latest version of Current production release (|version|). Points to the latest version of
the latest series. Production quality code. the latest series. Production quality code.
``feature/`` ``features/``
Unfinished/unmerged feature. Likely unstable, don't use in production. Working branches for unfinished and unmerged feature. Likely unstable,
don't use in production. Once the feature is complete, it is merged
into one of the versions branches and deleted.
Special branches: Special branches:
``releases/all`` ``releases/all``
Used by the continuous delivery system to trigger the build and release Pushing code to this branch will trigger the build and release
a new Docker image, Documentation and Python package. a new Docker image, Documentation and Python package.
``releases/docker`` ``releases/docker``
Used by the continuous delivery system to trigger the build and release Pushing code to this branch will trigger the build and release
of a new Docker image to Docker Hub. of a new Docker image to Docker Hub.
``releases/documentation`` ``releases/documentation``
Used by the continuous delivery system to trigger the build and release Pushing code to this branch will trigger the build and release
of new documentation. of new documentation.
``releases/python`` ``releases/python``
Used by the continuous delivery system to trigger the build and release Pushing code to this branch will trigger the build and release
of a new Python package to PyPI. of a new Python package to PyPI.
``nightly`` ``nightly``
Used by the continuous delivery system to trigger the build and release Pushing code to this branch will trigger the build and release
of a new Docker image based on development code to the GitLab image of a new Docker image based on development code to the GitLab image
repository. repository only. The image will not be published to Docker Hub.
Each release is tagged separately using annotated Git tags. Each release is tagged separately using annotated Git tags.