Skip to content

Commit 9ed92d6

Browse files
committed
Use "release candidate" in book (#2920)
## Issue Addressed NA ## Proposed Changes Since we use the `rc` (release candidate) tag in our version strings, it seems consistent if we also use "release candidate" in the book rather than "pre-release". Notably, Github adds a "pre-release" tag to release when we request. I think it's OK that Github uses that term whilst we consistently use "release candidate". Our docs indicate that the terms are interchangeable. ## Additional Info I hope to use the new docs link in the `v2.1.0` release, so it would be nice if we can merge this soon 🙏
1 parent a836e18 commit 9ed92d6

File tree

2 files changed

+45
-38
lines changed

2 files changed

+45
-38
lines changed

book/src/advanced-pre-releases.md

Lines changed: 2 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,4 @@
11
# Pre-Releases
22

3-
[sigp/lighthouse]: https://github.com/sigp/lighthouse
4-
[sigp/lighthouse/releases/latest]: https://github.com/sigp/lighthouse/releases/latest
5-
[sigp/lighthouse/releases]: https://github.com/sigp/lighthouse/releases
6-
[`v1.4.0-rc.0`]: https://github.com/sigp/lighthouse/releases/tag/v1.4.0-rc.0
7-
[`v1.4.0`]: https://github.com/sigp/lighthouse/releases/tag/v1.4.0
8-
9-
From time-to-time, Lighthouse *pre-releases* will be published on the [sigp/lighthouse] repository.
10-
These releases have passed the usual automated testing, however the developers would like to see it
11-
running "in the wild" in a variety of configurations before declaring it an official, stable
12-
release. Pre-releases are also used by developers to get feedback from users regarding the
13-
ergonomics of new features or changes.
14-
15-
Github will clearly show such releases as a "Pre-release" and they *will not* show up on
16-
[sigp/lighthouse/releases/latest]. However, pre-releases *will* show up on the
17-
[sigp/lighthouse/releases] page, so **please pay attention to avoid the pre-releases when you're
18-
looking for stable Lighthouse**.
19-
20-
### Examples
21-
22-
[`v1.4.0-rc.0`] has `rc` (release candidate) in the version string and is therefore a pre-release. This
23-
release is *not* stable and is *not* intended for critical tasks on mainnet (e.g., staking).
24-
25-
However, [`v1.4.0`] is considered stable since it is not marked as a pre-release and does not
26-
contain `rc` in the version string. This release is intended for use on mainnet.
27-
28-
## When to use a pre-release
29-
30-
Users may wish to try a pre-release for the following reasons:
31-
32-
- To preview new features before they are officially released.
33-
- To help detect bugs and regressions before they reach production.
34-
- To provide feedback on annoyances before they make it into a release and become harder to change or revert.
35-
36-
## When *not* to use a pre-release
37-
38-
It is not recommended to use pre-releases for any critical tasks on mainnet (e.g., staking). To test
39-
critical features, try one of the testnets (e.g., Prater).
40-
3+
Pre-releases are now referred to as [Release Candidates][./advanced-pre-releases.md]. The terms may
4+
be used interchangeably.
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Release Candidates
2+
3+
[sigp/lighthouse]: https://github.com/sigp/lighthouse
4+
[sigp/lighthouse/releases/latest]: https://github.com/sigp/lighthouse/releases/latest
5+
[sigp/lighthouse/releases]: https://github.com/sigp/lighthouse/releases
6+
[`v1.4.0-rc.0`]: https://github.com/sigp/lighthouse/releases/tag/v1.4.0-rc.0
7+
[`v1.4.0`]: https://github.com/sigp/lighthouse/releases/tag/v1.4.0
8+
9+
From time-to-time, Lighthouse *release candidates* will be published on the [sigp/lighthouse]
10+
repository. These releases have passed the usual automated testing, however the developers would
11+
like to see it running "in the wild" in a variety of configurations before declaring it an official,
12+
stable release. Release candidates are also used by developers to get feedback from users regarding the
13+
ergonomics of new features or changes.
14+
15+
Github will clearly show such releases as a "Pre-release" and they *will not* show up on
16+
[sigp/lighthouse/releases/latest]. However, release candidates *will* show up on the
17+
[sigp/lighthouse/releases] page, so **please pay attention to avoid the release candidates when
18+
you're looking for stable Lighthouse**.
19+
20+
From time to time, Lighthouse may use the terms "release candidate" and "pre release"
21+
interchangeably. A pre release is identical to a release candidate.
22+
23+
### Examples
24+
25+
[`v1.4.0-rc.0`] has `rc` in the version string and is therefore a release candidate. This release is
26+
*not* stable and is *not* intended for critical tasks on mainnet (e.g., staking).
27+
28+
However, [`v1.4.0`] is considered stable since it is not marked as a release candidate and does not
29+
contain `rc` in the version string. This release is intended for use on mainnet.
30+
31+
## When to use a release candidate
32+
33+
Users may wish to try a release candidate for the following reasons:
34+
35+
- To preview new features before they are officially released.
36+
- To help detect bugs and regressions before they reach production.
37+
- To provide feedback on annoyances before they make it into a release and become harder to change or revert.
38+
39+
## When *not* to use a release candidate
40+
41+
It is not recommended to use release candidates for any critical tasks on mainnet (e.g., staking).
42+
To test critical features, try one of the testnets (e.g., Prater).
43+

0 commit comments

Comments
 (0)