Skip to content

[Merged by Bors] - Use "release candidate" in book #2920

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

[Merged by Bors] - Use "release candidate" in book #2920

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 2 additions & 38 deletions book/src/advanced-pre-releases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,40 +1,4 @@
# Pre-Releases

[sigp/lighthouse]: https://github.com/sigp/lighthouse
[sigp/lighthouse/releases/latest]: https://github.com/sigp/lighthouse/releases/latest
[sigp/lighthouse/releases]: https://github.com/sigp/lighthouse/releases
[`v1.4.0-rc.0`]: https://github.com/sigp/lighthouse/releases/tag/v1.4.0-rc.0
[`v1.4.0`]: https://github.com/sigp/lighthouse/releases/tag/v1.4.0

From time-to-time, Lighthouse *pre-releases* will be published on the [sigp/lighthouse] repository.
These releases have passed the usual automated testing, however the developers would like to see it
running "in the wild" in a variety of configurations before declaring it an official, stable
release. Pre-releases are also used by developers to get feedback from users regarding the
ergonomics of new features or changes.

Github will clearly show such releases as a "Pre-release" and they *will not* show up on
[sigp/lighthouse/releases/latest]. However, pre-releases *will* show up on the
[sigp/lighthouse/releases] page, so **please pay attention to avoid the pre-releases when you're
looking for stable Lighthouse**.

### Examples

[`v1.4.0-rc.0`] has `rc` (release candidate) in the version string and is therefore a pre-release. This
release is *not* stable and is *not* intended for critical tasks on mainnet (e.g., staking).

However, [`v1.4.0`] is considered stable since it is not marked as a pre-release and does not
contain `rc` in the version string. This release is intended for use on mainnet.

## When to use a pre-release

Users may wish to try a pre-release for the following reasons:

- To preview new features before they are officially released.
- To help detect bugs and regressions before they reach production.
- To provide feedback on annoyances before they make it into a release and become harder to change or revert.

## When *not* to use a pre-release

It is not recommended to use pre-releases for any critical tasks on mainnet (e.g., staking). To test
critical features, try one of the testnets (e.g., Prater).

Pre-releases are now referred to as [Release Candidates][./advanced-pre-releases.md]. The terms may
be used interchangeably.
43 changes: 43 additions & 0 deletions book/src/advanced-release-candidates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Release Candidates

[sigp/lighthouse]: https://github.com/sigp/lighthouse
[sigp/lighthouse/releases/latest]: https://github.com/sigp/lighthouse/releases/latest
[sigp/lighthouse/releases]: https://github.com/sigp/lighthouse/releases
[`v1.4.0-rc.0`]: https://github.com/sigp/lighthouse/releases/tag/v1.4.0-rc.0
[`v1.4.0`]: https://github.com/sigp/lighthouse/releases/tag/v1.4.0

From time-to-time, Lighthouse *release candidates* will be published on the [sigp/lighthouse]
repository. These releases have passed the usual automated testing, however the developers would
like to see it running "in the wild" in a variety of configurations before declaring it an official,
stable release. Release candidates are also used by developers to get feedback from users regarding the
ergonomics of new features or changes.

Github will clearly show such releases as a "Pre-release" and they *will not* show up on
[sigp/lighthouse/releases/latest]. However, release candidates *will* show up on the
[sigp/lighthouse/releases] page, so **please pay attention to avoid the release candidates when
you're looking for stable Lighthouse**.

From time to time, Lighthouse may use the terms "release candidate" and "pre release"
interchangeably. A pre release is identical to a release candidate.

### Examples

[`v1.4.0-rc.0`] has `rc` in the version string and is therefore a release candidate. This release is
*not* stable and is *not* intended for critical tasks on mainnet (e.g., staking).

However, [`v1.4.0`] is considered stable since it is not marked as a release candidate and does not
contain `rc` in the version string. This release is intended for use on mainnet.

## When to use a release candidate

Users may wish to try a release candidate for the following reasons:

- To preview new features before they are officially released.
- To help detect bugs and regressions before they reach production.
- To provide feedback on annoyances before they make it into a release and become harder to change or revert.

## When *not* to use a release candidate

It is not recommended to use release candidates for any critical tasks on mainnet (e.g., staking).
To test critical features, try one of the testnets (e.g., Prater).