Skip to content

Commit f484172

Browse files
chore(release notes): fix the single-source-release-notes.py and readme to explain how to export a token before running the script (#1553)
Signed-off-by: Nick Boldt <[email protected]> Co-authored-by: Nick Boldt <[email protected]>
1 parent 8e3cdb2 commit f484172

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed

modules/release-notes/README.adoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,21 @@ Previously, the default Persistent Volume Claim (PVC) could only be mounted to t
3030

3131
. Open a terminal and change directory to the Git repository root.
3232

33+
. Create a JIRA token from https://issues.redhat.com/secure/ViewProfile.jspa?selectedTab=com.atlassian.pats.pats-plugin:jira-user-personal-access-tokens
34+
35+
. Export the token.
36+
+
37+
----
38+
export JIRA_TOKEN=NDA4NDY4....
39+
----
40+
3341
. Install required python modules.
3442
+
3543
----
3644
$ pip3 install --requirement requirements.txt
3745
----
3846

39-
. Single-source content from JIRA.
47+
. Generate new release note content from JIRA.
4048
+
4149
----
4250
$ python modules/release-notes/single-source-release-notes.py

modules/release-notes/single-source-release-notes.py

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,19 @@
88
SPDX-License-Identifier: Apache-2.0
99
1010
Prerequisites:
11-
$ pip3 install --requirement requirements.txt
11+
12+
1. create a JIRA token from https://issues.redhat.com/secure/ViewProfile.jspa?selectedTab=com.atlassian.pats.pats-plugin:jira-user-personal-access-tokens
13+
2. export the token
14+
15+
export JIRA_TOKEN=NDA4NDY4....
16+
17+
3. install requirements
18+
19+
pip3 install --requirement requirements.txt
20+
21+
4. run this scipt
22+
23+
python ./modules/release-notes/single-source-release-notes.py
1224
1325
Generate the AsciiDoc files for the release notes and known issues from JIRA content.
1426
"""

0 commit comments

Comments
 (0)