Skip to content

Commit a0848b9

Browse files
committed
Updated mermaid branch diagram
From later comments on the previous update. This shows a more comprehensive example, including merging patch releases from the most recent line _only_ back to `dev`.
1 parent fdbaebf commit a0848b9

File tree

1 file changed

+58
-6
lines changed

1 file changed

+58
-6
lines changed

CONTRIBUTING.md

Lines changed: 58 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,23 +57,50 @@ Initiating the next minor release after releasing `X.Y.0`:
5757

5858
Other notes:
5959

60-
* Patch releases are _not_ merged to `dev`
60+
* Patch releases are _only_ merged to `dev` if they are part of the most recent release line (currently 3.1, which will shift to 3.2 once 3.2.0 is released).
61+
* When releasing from multiple lines, release from the oldest line first.
62+
63+
_Release lines are grouped by color, although the colors of `dev` and `main` are not significant as these diagrams are limited to only 8 colors._
6164

6265
```mermaid
66+
---
67+
config:
68+
themeVariables:
69+
git0: "#5588bb"
70+
git1: "#cc8899"
71+
git2: "#eedd88"
72+
git3: "#ccbb66"
73+
git4: "#aa9944"
74+
git5: "#887722"
75+
git6: "#99ccff"
76+
git7: "#77aadd"
77+
gitBranchLabel1: "#000000"
78+
gitBranchLabel2: "#000000"
79+
gitBranchLabel3: "#000000"
80+
gitBranchLabel4: "#000000"
81+
gitBranchLabel5: "#ffffff"
82+
gitBranchLabel6: "#000000"
83+
gitBranchLabel7: "#000000"
84+
---
6385
gitGraph TB:
6486
commit id:"merge 3.1.1.md to main" tag:"3.1.1"
6587
branch dev order:1
6688
commit id:"rename 3.1.1.md to src/oas.md"
6789
branch v3.1-dev order:2
6890
commit id:"update version in src/oas.md to 3.1.2"
6991
checkout dev
70-
branch v3.2-dev order:5
92+
branch v3.2-dev order:6
7193
commit id:"update version in src/oas.md to 3.2.0"
7294
commit id:"some 3.2.0 work"
7395
checkout v3.1-dev
7496
commit id:"a 3.1.x fix"
97+
checkout v3.2-dev
98+
merge v3.1-dev id:"merge 3.1.2 fixes"
99+
checkout v3.1-dev
75100
branch v3.1.2-rel order:3
76101
commit id:"rename src/oas.md to versions/3.1.2.md"
102+
checkout dev
103+
merge v3.1-dev id:"update dev with active line patch release"
77104
checkout main
78105
merge v3.1.2-rel tag:"3.1.2"
79106
checkout v3.2-dev
@@ -83,25 +110,50 @@ gitGraph TB:
83110
commit id:"another 3.1.x fix"
84111
checkout v3.2-dev
85112
commit id:"still more 3.2.0 work"
86-
merge v3.1-dev id:"merge 3.1.x fixes before releasing"
113+
merge v3.1-dev id:"merge 3.1.3 fixes before releasing"
114+
checkout dev
115+
merge v3.1-dev id:"update dev with last pre-minor release patch release"
116+
merge v3.2-dev id:"update dev with minor release"
87117
checkout v3.1-dev
88118
branch v3.1.3-rel order:4
89119
commit id:"rename src/oas.md to versions/3.1.3.md"
90120
checkout v3.2-dev
91-
branch v3.2.0-rel order:6
121+
branch v3.2.0-rel order:7
92122
commit id:"rename src/oas.md to versions/3.2.0.md"
93123
checkout main
94124
merge v3.1.3-rel tag:"3.1.3"
95125
merge v3.2.0-rel tag:"3.2.0"
96126
checkout dev
97-
merge v3.2-dev id:"update dev with minor release"
98-
branch v3.3-dev order:7
127+
branch v3.3-dev order:9
99128
checkout v3.1-dev
100129
commit id:"update version in src/oas.md to 3.1.4"
101130
checkout v3.2-dev
102131
commit id:"update version in src/oas.md to 3.2.1"
103132
checkout v3.3-dev
104133
commit id:"update version in src/oas.md to 3.3.0"
134+
135+
checkout v3.1-dev
136+
commit id:"a 3.1.4 fix"
137+
checkout v3.2-dev
138+
commit id:"a 3.2.1 fix"
139+
merge v3.1-dev id:"merge 3.1.4 fixes before releasing"
140+
checkout v3.3-dev
141+
merge v3.2-dev id:"merge 3.1.4 / 3.2.1 fixes"
142+
checkout dev
143+
merge v3.2-dev id:"merge patch from active release line"
144+
checkout v3.1-dev
145+
branch v3.1.4-rel order:5
146+
commit id:"rename src/oas.md to versions/3.1.4.md"
147+
checkout v3.2-dev
148+
branch v3.2.1-rel order:8
149+
commit id:"rename src/oas.md to versions/3.2.1.md"
150+
checkout main
151+
merge v3.1.4-rel tag:"3.1.4"
152+
merge v3.2.1-rel tag:"3.2.1"
153+
checkout v3.2-dev
154+
commit id:"update version in src/oas.md to 3.2.2"
155+
checkout v3.3-dev
156+
commit id:"3.3 work"
105157
```
106158

107159
### Schema development

0 commit comments

Comments
 (0)