Skip to content

Commit 06e049d

Browse files
pbrezinaalexey-tikhonov
authored andcommitted
contrib: document releasing SSSD
1 parent 263fe39 commit 06e049d

2 files changed

Lines changed: 40 additions & 0 deletions

File tree

src/contents.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Table of Contents
1010
Introduction <contrib/introduction>
1111
contrib/building-sssd
1212
contrib/debugging-sssd
13+
contrib/releasing-sssd
1314
contrib/coding-style
1415
contrib/tests
1516
contrib/profiling-sssd

src/contrib/releasing-sssd.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Releasing SSSD
2+
##############
3+
4+
This is a step by step guide for core developers on releasing a new SSSD
5+
version.
6+
7+
#. Find all `opened Weblate pull requests <https://github.com/SSSD/sssd/pulls?q=is%3Apr+is%3Aopen+weblate>`__ (translations)
8+
9+
#. Make sure SSSD builds (PR CI build job), sometimes new translations introduce errors
10+
#. If not, fix the translations at
11+
https://translate.fedoraproject.org/projects/sssd
12+
#. Merge them
13+
14+
#. If this is a new major release, make sure the master branch PR CI is green
15+
and create a branch sssd-X-Y (e.g. sssd-2-12) and push it to SSSD repository.
16+
If this is a minor release and the branch already exist, make sure PR CI is
17+
green.
18+
#. Go to https://github.com/SSSD/sssd/actions/workflows/release.yml
19+
#. Click on "Run workflow" and provide parameters:
20+
21+
* Target branch to release from: sssd-X-Y, e.g. sssd-2-12
22+
* Release version: X.Y.Z, e.g. 2.12.6
23+
* Previous version: X.Y.Z-1, e.g. 2.12.5
24+
25+
The workflow will create a new GitHub draft release and a pull request with
26+
release notes at sssd.io repository. Review, edit and merge the release notes,
27+
then publish the release on GitHub.
28+
29+
Packit will automatically create pull requests against active Fedora versions in
30+
Fedora sources. When the pull request is pushed, packit automatically creates
31+
koji build and bodhi update.
32+
33+
.. note::
34+
35+
We generate large release notes between two major releases to avoid issues,
36+
since the new release branch and old release branch diverged. If the last
37+
release is 2.12.6 and you are releasing a new major release 2.13.0 provide
38+
2.12.0 as the previous version. Release notes will be generated between
39+
``2.12.0..2.13.0``.

0 commit comments

Comments
 (0)