Skip to content

Commit 7d8af5b

Browse files
authored
doc: use Customizable Header for system messages (#4213)
Update the security releases documentation to switch to using the Customizable Header plugin for system messages. This will show the message on all pages, including the error page shown to anyone whose access to Jenkins is restricted during the security release preparation. Fixes: #4203
1 parent 86da260 commit 7d8af5b

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

doc/jenkins-guide.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,13 +98,21 @@ referencing the discussion post.
9898
You must be a member of the `nodejs/jenkins-admins` team to have the necessary
9999
permissions to lock down the CI.
100100

101-
Add a Jenkins "system message" in https://ci.nodejs.org/configure. Something like:
101+
Add a system message to Jenkins by going to https://ci.nodejs.org/manage/appearance
102+
and under "Customizable Header" click the "+ Add System message" button. In the
103+
"Message" field that is created, enter something like:
104+
102105
```html
103106
<h1 style="color:red">system is under embargo for a security release</h1>
104107
<h2>For solidarity, even if you have access, please don't start unrelated jobs</h2>
105108
<p>Refs: <a href="https://github.com/nodejs/build/issues/xxx">https://github.com/nodejs/build/issues/xxx</a></p>
106109
```
107110

111+
Unselect "Dismissible" and change the "Background of System Message" to
112+
"Warning".
113+
114+
![](../static-assets/jenkins-set-system-message.png)
115+
108116
To make it more obvious that the CI has been locked down, add some "Extra CSS"
109117
to https://ci.nodejs.org/manage/appearance.
110118
This should already exist but commented out like this:
@@ -174,8 +182,7 @@ Relevant logs:
174182
1. system (includes security matrix) - https://ci.nodejs.org/jobConfigHistory/history?name=config
175183
2. CSS - https://ci.nodejs.org/jobConfigHistory/history?name=org.codefirst.SimpleThemeDecorator
176184

177-
Undo the "system message" changes from https://ci.nodejs.org/configure and
178-
"Extra CSS" theme changes from https://ci.nodejs.org/manage/appearance.
185+
Undo the "system message" changes and "Extra CSS" theme changes from https://ci.nodejs.org/manage/appearance.
179186

180187
## Solving problems
181188

128 KB
Loading

0 commit comments

Comments
 (0)