Skip to content
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.

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

feat: remove hardcoded versions in chain-upgrade docs #26

Merged
merged 1 commit into from
Aug 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 1 addition & 3 deletions pages/node/pd/chain-upgrade.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
import {PENUMBRA_VERSION} from '../../../penumbra_versions.js';

# Performing a chain upgrade

When consensus-breaking changes are made to the Penumbra protocol,
Expand Down Expand Up @@ -29,7 +27,7 @@ Consider performing a backup as a preliminary step during the downtime,
so that your node state is recoverable.

1. Stop both `pd` and `cometbft`. Depending on how you run Penumbra, this could mean `sudo systemctl stop penumbra cometbft`.
2. Download the latest version of `pd` and install it. Run `pd --version` and confirm you see "{PENUMBRA_VERSION}" before proceeding.
2. Download the latest version of `pd` and install it. Run `pd --version` and confirm you see the correct version.
3. Optionally, use `pd export` to create a snapshot of the `pd` state.
4. Apply the migration with `pd migrate --home PD_HOME --comet-home COMETBFT_HOME`. If using the default home locations (from `pd network join`), you can omit the paths and just run `pd migrate`.

Expand Down
3 changes: 1 addition & 2 deletions pages/node/pd/install.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { PENUMBRA_VERSION, COMETBFT_VERSION } from '../../../penumbra_versions.js';
import { COMETBFT_VERSION } from '../../../penumbra_versions.js';

# Installing pd
There are many ways to configure and run Penumbra. The easiest is to download
Expand All @@ -21,7 +21,6 @@ sudo mv pd-x86_64-unknown-linux-gnu/pd /usr/local/bin/
# confirm the pd binary is installed by running:
pd --version
```
Make sure the version that's installed is at least <code>{PENUMBRA_VERSION}</code>.
There's also a one-liner install script available on the release page, which will install `pd` to `$HOME/.cargo/bin/`.

### Installing CometBFT
Expand Down
2 changes: 1 addition & 1 deletion penumbra_versions.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
// works in normal prose, but fails in backticked-codeblocks. There's some discussion
// about how to do this better in https://github.com/orgs/mdx-js/discussions/2288.

export const PENUMBRA_VERSION = 'v0.79.2';
export const PENUMBRA_VERSION = 'v0.79.3';
export const COMETBFT_VERSION = 'v0.37.9';