Skip to content

Commit 6c06ab6

Browse files
jufajardinivictorjulien
authored andcommitted
devguide: update backports policy for Suricata 7.0
Also remove mentions to `master` and `6.0x`. Task OISF#7937
1 parent e387804 commit 6c06ab6

2 files changed

Lines changed: 16 additions & 10 deletions

File tree

doc/userguide/devguide/contributing/backports-guide.rst

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ Suricata releases. Most often, this means security and/or bug fixes;
77
however, in some cases, features may be backported to previous Suricata releases.
88

99
There are multiple versions of Suricata at any given time:
10-
* Master
10+
* Main
1111
* Major stable release
1212
* Old stable release
1313

1414
For example, at the moment, there are 3 releases based on these Suricata branches:
15-
* main: 8.0.0-dev, current development branch
16-
* main-7.0.x: major stable release (note we're changing our naming conventions)
17-
* master-6.0.x: old stable release
15+
* main: 9.0.0-dev, current development branch
16+
* main-8.0.x: major stable release
17+
* main-7.0.x: old stable release
1818

1919
For Suricata's release cadence and *end of life* policies, please check
2020
https://suricata.io/our-story/eol-policy/.
@@ -38,6 +38,12 @@ The general principle used to determine what will be backported is:
3838
* in some cases, new features are backported if there are sufficient reasons to
3939
backport a new feature.
4040

41+
.. note:: 7.0.x backports
42+
43+
With the release of Suricata 8.0, Suricata 7 has reached a mature stage of its
44+
release cycle. Thus, as a rule, only critical issues (bugs and security),
45+
should be considered for backporting.
46+
4147
.. Note:: Exceptions
4248

4349
There can be cases where backports may be "missed" -- some issues may not be
@@ -63,10 +69,10 @@ Creating backport tickets -- new issues
6369

6470
Redmine: for security and bug fixes, when creating a new Redmine issue,
6571
label the Redmine issue with "Needs backport to x.0", where x.0 is a supported
66-
Suricata release, e.g, 7.0.x.
72+
Suricata release, e.g, 8.0.x.
6773

68-
Creating backports tickets -- existing issues/PRs
69-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
74+
Creating backport tickets -- existing issues/PRs
75+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7076

7177
We want to minimize the occurrence of "missed backports" -- that is, work that
7278
should be backported but wasn't. Sometimes this happens when there is no Redmine
@@ -94,7 +100,7 @@ backporting process once the PR for main has been merged. Then:
94100
backported.
95101
* *Bring each commit into the new branch,* one at a time -- starting with the
96102
oldest commit. Use ``git cherry-pick -x commit-hash``, where ``commit-hash``
97-
is the hash to the commit already in main or main-7.0x that is being
103+
is the hash to the commit already in main or main-8.0x that is being
98104
backported, as it maintains the linkage with said cherry-picked commit.
99105
* *Resolve conflicts:* Some of the cherry-picked commits may contain merge
100106
conflicts. If the conflicts are small, include the corrections in the
@@ -116,7 +122,7 @@ Create a PR:
116122
~~~~~~~~~~~~
117123

118124
Please indicate in the title that this is a backport PR, with something like
119-
*(7.0.x-backport)*, and add the related milestone label.
125+
*(8.0.x-backport)*, and add the related milestone label.
120126

121127
In the PR description, indicate the backport ticket.
122128

doc/userguide/devguide/contributing/contribution-process.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,8 +181,8 @@ What branch to work on
181181

182182
There are usually 2 or 3 active branches:
183183

184-
* master-x.x.x (e.g. master-6.0.x)
185184
* main-x.x.x (e.g. main-7.0.x)
185+
* main-x.x.x (e.g. main-8.0.x)
186186
* main
187187

188188
The ones with version numbers are stable branches. **main** is the development branch.

0 commit comments

Comments
 (0)