diff --git a/README.md b/README.md index 3974e864..b690b59d 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ to operate. In this model we operate with release branches (e.g. `1.0.x`, `1.1.x`, `1.2.x`). This provides a lot of flexibility whilst keeping a single workflow. -![](./docs/branching-model.png) +![](./docs/branching-model.svg) ### Working on new features @@ -72,7 +72,7 @@ deprecation notices and `4.0.x` for the next major release. ### Working on bug fixes Bug fixes should be applied on the version which introduced the issue and then synchronized all way to -the current default release branch. +the current default release branch via merge-ups. ### Releasing @@ -83,8 +83,9 @@ default release branch. To keep branches synchronized merge-ups are used. -That consists in getting the changes of a specific released branch merged all the way up to `master`. -This ensures that all release branches and the `master` branch are up-to-date and will never present a bug which has already been fixed. +That consists in getting the changes of a specific released branch merged all the way up to the current +default branch. This ensures that all release branches are up-to-date and will never present a bug which +has already been fixed. **Example** diff --git a/docs/branching-model.jpg b/docs/branching-model.jpg new file mode 100644 index 00000000..35c926af Binary files /dev/null and b/docs/branching-model.jpg differ diff --git a/docs/branching-model.png b/docs/branching-model.png deleted file mode 100644 index cc273bab..00000000 Binary files a/docs/branching-model.png and /dev/null differ diff --git a/docs/branching-model.svg b/docs/branching-model.svg new file mode 100644 index 00000000..3ce6f952 --- /dev/null +++ b/docs/branching-model.svg @@ -0,0 +1,3 @@ + + +
Hotfix
Hotfix
1.1.x
1.1.x
1.2.x
1.2.x
2.0.x
2.0.x
Current default feature branch
Current default feature branch
BC breaking feature development
BC breaking feature development
1.1.x release branch
1.1.x release branch
1.0.x release branch
1.0.x release branch
Tag: 1.0.0
Tag: 1.0.0
Tag: 1.0.1
Tag: 1.0.1
Tag: 1.1.0
Tag: 1.1.0
Feature
Feature
Feature
Feature
Tag: 1.2.0
Tag: 1.2.0
Tag: 1.0.2
Tag: 1.0.2
Hotfix
Hotfix
Hotfix
Hotfix
Tag: 1.1.2
Tag: 1.1.2
Hotfix
Hotfix
Tag: 1.2.1
Tag: 1.2.1
Feature
Feature
Hotfix
Hotfix
Hotfix
Hotfix
Start 1.1.x
Start 1.1.x
Start 1.2.x
Start 1.2.x
Start 2.0.x
Start 2.0.x
1.0.x
1.0.x
Viewer does not support full SVG 1.1
\ No newline at end of file diff --git a/docs/branching-model.tex b/docs/branching-model.tex deleted file mode 100644 index 196d327a..00000000 --- a/docs/branching-model.tex +++ /dev/null @@ -1,66 +0,0 @@ -\documentclass[preview]{standalone} -\usepackage{subcaption} -\usepackage{gitdags} -\begin{document} -\begin{figure} - \begin{subfigure}[b]{\textwidth} - \centering - \begin{tikzpicture} - % Commit DAG - \gitDAG[grow right sep = 2em]{ - A -- B -- { - G -- H, - C -- D -- E -- { - I -- H, - F -- J -- K - } - } - }; - % Branch - \gittag - [v1p0p0] % node name - {1.0.0} % node text - {above=of B} % node placement - {B} % target - \gittag - [v1p0p1] % node name - {1.0.1} % node text - {above=of H} % node placement - {H} % target - \gitbranch - {fix-bug} % node name and text - {above=of G} % node placement - {G} % target - \gitbranch - [1p0px] - {1.0.x} % node name and text - {above=of v1p0p1} % node placement - {v1p0p1} % target - \gittag - [v1p1p0] % node name - {1.1.0} % node text - {above=of E} % node placement - {E} % target - \gittag - [v1p1p1] % node name - {1.1.1} % node text - {above=of I} % node placement - {I} % target - \gitbranch - [1p1px] - {1.1.x} % node name and text - {above=of v1p1p1} % node placement - {v1p1p1} % target - \gitbranch - [2p0px] - {2.0.x} % node name and text - {above=of K} % node placement - {K} % target - % HEAD reference - \gitHEAD - {above=of 2p0px} % node placement - {2p0px} % target - \end{tikzpicture} - \end{subfigure} -\end{figure} -\end{document} diff --git a/docs/branching-model.xml b/docs/branching-model.xml new file mode 100644 index 00000000..644f2bd3 --- /dev/null +++ b/docs/branching-model.xml @@ -0,0 +1 @@ +7V1bc+I4Fv41PEJJ8v2xQ5Lp1HRPZapnay4vWw4I8LaxGGMSyK9fG2SwfWQjQL6QkH5oJGTZ6Dv3cyT3tOF8/UvoLmbf2Zj6PYLG65523yMEI82O/0t6NrseA6FdxzT0xnzQoeOH907TK3nvyhvTZW5gxJgfeYt854gFAR1FuT43DNlbftiE+fm7LtwpBR0/Rq4Pe//0xtGM92LTOXzxlXrTGb+1TazdF3M3Hcx/yXLmjtlbpkt76GnDkLFo92m+HlI/Wbx0XXbXPZZ8u3+wkAaRzAWhOdu4v6+Cd/Nn/1/KcNAfRX3N2E3z6vor/ov500abdAnoOF4R3mRhNGNTFrj+w6H3brQKX2lyGxw3QrYKxtsWiluHC74xtuBD/kejaMOxdlcRi7tm0dzn39Jg/CVBLm4GLKC7nkfP9/mUyyhkP/do6HHPhAXRozv3/ITIvlL/lUbeyOVfDJnPwu0v0dD2bz9F5hsd22SUTAVXlS/0kq3CEa1aSpOTpxtOaVQ1kFNIsq6ZW3DUfqFsTqNwEw8Iqe9G3mueEl1O0NP9uAPm8QcO+wkkoJNPSQJ07UV/pbeLP/+dTD0weOt+ze+0bWwyjWcaevHC0zD3KGpJCSunEH7pM/PiZyEIiGcunTVTz8+xe1R+WVa4gJlsVD3Tji3ATFuS3f8iKSpe/fmf4LeHe/Prg0/cX43J2H166VuAiL+yaOKtASlHdB3liS2PIKe3SUxshS7X96ZB3BzFeCbw373SMCEy/wv/Yu6Nx1tmeJt5Ef2xcLcgv8WKMeGCePTE35L0LB5HA0ibNkr+VVFOcke6riQJ/q2OjYGp5SDZ69S3gyIz8MDiKmCW0WIaulzYCGGyVciavHjJICkQKkLhs/BdL+i/bJ/hDFlTzvIxXuHmr1RaJI2MWEmaB7mybW2yraJkkZIfwlVOgc6qImd29+vz/TvzorfF0934/fH+d6uPTUlBw6mKOPrAyBMVOlnq6PrRSWoWFo5aBZdVXJVapYjwUXKBF1TTqiwDiPUnvxBDoXiyWpMmS/FAoy0LqfK5q6RWqgu+uS/Uf2ZLL/JYohNeWBSxuUBZRAkYUA3l5MzMXSTTz9fTxLkaJOpjNHPDaMCCfuJ4/DekExrjkKx6XqjFF4w9etAunFqEqA51sb5ToIWIaRRYHdsmUEKptmlEA2El5u7FKgiiLaeHTuLI44yGTpP/WIX8JwhVT1FidKqS/ljvjPi/amluyBJZa/5u5XNfgzRfrMKF3yF5rulWnnXNtqW52Rle/lymXEMRCgMXdIXdrKeAYVzhJixkQxDEHJCCtdC2vCDQlMcDPKgjTOTTSaQqSJSys5m2+YPiYuRzGDOuF8sYgn6jb2pgxMSBMDoAxjTel4WR1AWjZQpgJDcYT4NRM2BA0BREA2uD0YYwkgH6uDDuU4CJgp/67nLZOxLquwhfndgQ34NMbgZiqECHq3D7Owka04m78pNPE+pGq5D2iOnOk6UPXpbJfy+hG4xmV0IOeoEcUE+QfXIcVB/gmoUB4KRZuGGA/y6eCb2E1P3pBdMs1DH8r9RniznlttsNYgmeNlqH2CkzoRJjn7pLusX7xrinGFQO1MRYb9KickSGMbqhehGqgoQr1uxBk9zqYIArwC8TihglRok3qnJPj1o5ZYtc7n+WLv/R8EI2lS3wI9O+S+sknHzYS9ecFMRTCyVsPR/Q0PUC8nWnPmXSHzd6OJbBiDVevrhCM9G5JGGC0pmGs+HajSQUkEQxUInOowZiH5mo7ognguTwhzvtaV96CdmjAQLE0bWSqjILQFAye3pGGxSvYBNqeUtAaLWpeIwkgtQfsYJTZbFVPfUu3II/WhKs25LC7EIpZenmvt6vrYxKuii3lMrp0sc0Qf1FgxkVYQkhkXEwTqynOUPeFJOeKqs6pSTAZfWVFxdyF62G+ioqK3/oNTA1L5EDeDsaubdQgXfj/sftn0AIZK9RwNxJvrS9YjkhrCZk7pwtiAHI12MLqsEMAcwaNAeFtoSEg98VTuyaejXsYrlqk+pViKah1pI/wUJXV4DUtqF+1PwmQi0tsVFL12pR54ZejAHIVcjC0BIhIChtFcJU6iwD4RJB3zSjQfBVRxPUmPQEmPQ6TPFh3KQKgRm+xzRp23GwattNR4ogORAkw2xQMchsSvmoflfz7pRkkATM5KS7wk+U5PEaupvMsEUyYFmHfMbd8N8b99fFi0EkLYZ0D0lH9vDLbGq6Gf1i2S6IiWo6rG9t1OrHMim5zkf027b7j7O7bHy+qe0ODsqrixpPUahckJscOV2O2HC7Q/ty5CNsX8mGWU8P2ipA1rHNjsFqt2OicXGOFYjz07VJTpulm/PSU3k6dXqPwIisToXWnva1CgTsnFmcYhEnPxGurThFvLQXn9yhcLO2mgApqaTZcnknlspFKWgPH4ZDsUx9+GLemaYspbea3tQQiMvjMyOicEOpHAWXO+Ti++glCdmy5wLj7dxpfvGH3RMoZSfBbshPHugzrM4F+ogSX7ADgT5VJ+513q3snP43zaJwIVJCT5BPOjLRyeHMkvvgYtiU1C8NtQ8RdKnlaFPZOImm3CC4SHRqt3DG+U5vbHNZxf3EBlCFjfq92hVVmXUOT1Db0j6ct+iUAmAxAofstY/sLUDV4QCVtDpXn+WUS3voppxZCXdXGhrI5VmOlK2rzIqExTOZgidyK3iybAvkSVK3orWKJ13C9u+KKio54rV1RWSg9g4HFIN6Reb/0U0JVXDXCKpNALdiu2XrQocneOZ2JUCUP5mItREEzYA5y0a3JejQd/vkb2hwjEGaKqyKNdf3hgYxTrc3aRSYCRuDwmtSCILM1DhOEq/S6Jhy65zFUvQ7iGm1rNkqnQd802x2oRRHtFeiUbVmwBTqJxeXjl48G6cLas3QACDHI1JKEjYNBYqUBr+KBSrqik3K5Xwp7R3fhcdV4fFjNhqLZxXTpFp+Cul4llWsImm23so451UZjXCN0lCvIhaU4xp5S0dZ8VZlbXBnDqdxwDloZ0aBHaPIfg1zTWV8gtxOTXDMQj0qac6K+6YtR973u6f3pz4aP/v4n6d/3D7cA3f9dXAADgFo5QhZ+iA9Qqbi5OG6CuGEIJGPZ2lfjFEqIvfJLr1JS1sIE8ykfG6YMDIATkJeahgnmBz5EevFiEcaPi1cWrHEUeC82jXFhIQ4QWPigFM9rzy5CpwsgmGqH0q/RqGCKY4Uqrpea3IVUNk2kjEm6oJK7NRAI7wmz7bWmqQjbnIbHqkqb7qEys7frS1TGWWJCfni80QKBfjg1Hdp11YveE6pyFPv2optcGiE44/8xiYV9h98MQS2Yf5Q0fvT4mbIWJRFPUnTfWdjmoz4Pw== \ No newline at end of file