You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: release_tools/README.adoc
+17-15Lines changed: 17 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,31 +2,33 @@
2
2
3
3
== Prerequisities ==
4
4
5
-
* The `.env` file.
6
-
Create `.env` file in this directory (i.e. where the release scripts are).
7
-
You are supposed to define environment variables that contain sensitive information, s.a. GitHub access tokens.
8
-
Exact contents of the file are described below.
9
-
10
-
* Github automation
11
-
* System with `python3.6` or greater, installed https://pypi.python.org/pypi/PyGithub/1.35[PyGithub] module.
12
-
* A Github token - get one on https://github.com/settings/tokens and put it in the `.env` file, so it contains the line `GITHUB_TOKEN='<your token here>'`.
5
+
* System with `python3.6` or greater, installed https://pypi.python.org/pypi/PyGithub/1.35[PyGithub] module.
6
+
* A GitHub token - get one on https://github.com/settings/tokens. Choose `repo` scope.
2. Check out that the information within `versions.sh` is accurate.
14
+
. Create `.env` file
15
+
+
16
+
You are supposed to define environment variables that contain sensitive information, s.a. GitHub access tokens.
17
+
Create an `.env` file in the `release_tools` directory (i.e. where the release scripts are).
18
+
Put your GitHub token in the `.env` file, so it contains the following line:
19
+
20
+
GITHUB_TOKEN='<your token here>'
21
+
22
+
. Check out that the information within `versions.sh` is accurate.
21
23
+
22
-
Openscap versions are supposed to have correct values from the previous build (see the step 6), but e.g. the `latest_fedora` and `latest_rhel` may need to be updated if work on a distribution with new version has begun.
24
+
OpenSCAP versions are supposed to have correct values from the previous build (see the step 6), but e.g. the `latest_fedora` and `latest_rhel` may need to be updated if work on a distribution with new version has begun.
23
25
24
-
3. Run `up_to_compliance_check.sh`.
26
+
. Run `up_to_compliance_check.sh`.
25
27
+
26
28
In the ideal case, the script ends after the ABI compatiblity check finishes.
27
29
Review the check results and act accordingly to them.
28
30
29
-
4. Run `handle_ltversions.sh`.
31
+
. Run `handle_ltversions.sh`.
30
32
+
31
33
According to the result from the compliance check (and the decision what to do about possible API/ABI changes), you run the script with an argument `bugfix`, `backwards_compatible` or `breaking_change`.
32
34
+
@@ -39,7 +41,7 @@ Use this guideline to decide:
39
41
+
40
42
This changes the libtool library version number so it reflects the API/ABI change.
41
43
42
-
5. Update the NEWS and make the release commit.
44
+
. Update the NEWS and make the release commit.
43
45
+
44
46
Make sure that everything in the repository is in place, and that the only thing missing is the `NEWS` file and tags.
45
47
Use the `news_template.sh` script to generate a starting point for your `NEWS` file.
@@ -49,7 +51,7 @@ Use it to update the `NEWS` file and commit it.
49
51
+
50
52
The last commit before the release has to have the `openscap-<version>` message (e.g. `openscap-1.2.17`).
51
53
52
-
6. Run `new-release.sh`.
54
+
. Run `new-release.sh`.
53
55
+
54
56
This will create and push version tags, create new GitHub release and handle milestones swap.
55
57
Finally, it will bump version numbers in `versions.sh` to be ready for the next upstream release.
0 commit comments