Skip to content

Commit 7e38d20

Browse files
committed
Add "update priority" (#2988)
## Issue Addressed NA ## Proposed Changes Add the "Update Priority" section which has featured in many of our previous releases (e.g., [Poñeta](https://github.com/sigp/lighthouse/releases/v2.1.1)). Previously this section has been copied in manually. ## Additional Info NA
1 parent 5388183 commit 7e38d20

File tree

3 files changed

+36
-0
lines changed

3 files changed

+36
-0
lines changed

.github/workflows/release.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,19 @@ jobs:
232232
233233
Add a summary.
234234
235+
## Update Priority
236+
237+
This table provides priorities for which classes of users should update particular components.
238+
239+
|User Class |Beacon Node | Validator Client|
240+
--- | --- | ---
241+
|Staking Users| <TODO> | <TODO> |
242+
|Non-Staking Users| <TODO>|---|
243+
244+
*See [Update
245+
Priorities](https://lighthouse-book.sigmaprime.io/installation-priorities.html)
246+
more information about this table.*
247+
235248
## All Changes
236249
237250
${{ steps.changelog.outputs.CHANGELOG }}

book/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
* [Raspberry Pi 4](./pi.md)
1212
* [Cross-Compiling](./cross-compiling.md)
1313
* [Homebrew](./homebrew.md)
14+
* [Update Priorities](./installation-priorities.md)
1415
* [Key Management](./key-management.md)
1516
* [Create a wallet](./wallet-create.md)
1617
* [Create a validator](./validator-create.md)

book/src/installation-priorities.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Update Priorities
2+
3+
When publishing releases, Lighthouse will include an "Update Priority" section in the release notes. As an example, see the [release notes from v2.1.2](https://github.com/sigp/lighthouse/releases/tag/v2.1.2)).
4+
5+
The "Update Priority" section will include a table which may appear like so:
6+
7+
|User Class |Beacon Node | Validator Client|
8+
--- | --- | ---
9+
|Staking Users| Medium Priority | Low Priority |
10+
|Non-Staking Users| Low Priority|---|
11+
12+
To understand this table, the following terms are important:
13+
14+
- *Staking users* are those who use `lighthouse bn` and `lighthouse vc` to stake on the Beacon Chain.
15+
- *Non-staking users* are those who run a `lighthouse bn` for non-staking purposes (e.g., data analysis or applications).
16+
- *High priority* updates should be completed as soon as possible (e.g., hours or days).
17+
- *Medium priority* updates should be completed at the next convenience (e.g., days or a week).
18+
- *Low priority* updates should be completed in the next routine update cycle (e.g., two weeks).
19+
20+
Therefore, in the table above, staking users should update their BN in the next days or week and
21+
their VC in the next routine update cycle. Non-staking should also update their BN in the next
22+
routine update cycle.

0 commit comments

Comments
 (0)