Skip to content

Commit 3df5bff

Browse files
GitHub/contributions guide: reflect current workflow and branch names
1 parent 0417c0d commit 3df5bff

File tree

1 file changed

+14
-21
lines changed

1 file changed

+14
-21
lines changed

site/github.md

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -80,48 +80,41 @@ Generally, you can track QA'd development work by tracking the
8080
main (default) branches of the RabbitMQ repositories
8181
of interest.
8282

83+
Pull requests that are meant to ship in currently maintained release series,
84+
for example, 3.11.x, are backported to `v3.11.x`, `v3.10.x` and othe release series
85+
branches after being merged into the `main` branch.
86+
8387
## <a id="maintenance-branches" class="anchor" href="#maintenance-branches">Maintenance branch</a>
8488

8589
There's a separate branch for maintenance work,
86-
named after the current stable release series. Currently it is <code>v3.7.x</code>.
90+
named after the current stable release series. Currently it is <code>v3.11.x</code>.
91+
8792
It plays the same role as the <code>main</code> branch except that it carries merged,
8893
QA'd code intended for the next bug-fix release rather than
8994
the next general release.
9095

9196
## <a id="tags" class="anchor" href="#tags">Tags</a>
9297

93-
We also use tags to give names to snapshots of the state of
94-
the code. Generally, both the core repositories and the
98+
Team RabbitMQ uses tags in the git repository to give names to snapshots of the state of
99+
the code: mostly importantly, releases. Generally, both the core repositories and the
95100
repositories of plugins intended to work with the named
96101
snapshot are tagged.
97102

98-
For example, if you are using RabbitMQ server version 3.8.9,
103+
For example, if you are using RabbitMQ server version 3.11.5,
99104
then examining the output of <code>git tag</code> yields:
100105

101106
<pre class="lang-bash">
102107
git tag
103108
# omitted for brevity
104-
# => v3.8.5
105-
# => v3.8.5-rc.1
106-
# => v3.8.5-rc.2
107-
# => v3.8.6
108-
# => v3.8.6-beta.1
109-
# => v3.8.6-rc.1
110-
# => v3.8.6-rc.2
111-
# => v3.8.7
112-
# => v3.8.8
113-
# => v3.8.9
109+
# => v3.11.3
110+
# => v3.11.4
111+
# => v3.11.5
114112
</pre>
115113

116-
It's important to make sure that all the repositories you
117-
are using are on the same tag as each other. Continuing with
118-
our example of server version 3.8.9, make sure
119-
your checkout of <code>rabbitmq-stomp</code> was at the
120-
<code>v3.8.9</code> tag using
121-
<code>git checkout</code>:
114+
122115

123116
<pre class="lang-bash">
124-
git checkout v3.8.9
117+
git checkout v3.11.5
125118
</pre>
126119

127120
At this point, you could proceed with compiling the plugin

0 commit comments

Comments
 (0)