Skip to content

Commit

Permalink
[Docs] Update release process to include homebrew tap formula (#1064)
Browse files Browse the repository at this point in the history
## Summary

- Included [homebrew-poktroll
tap](https://github.com/pokt-network/homebrew-poktroll) updates in the
release process
- Update CLI documentation with troubleshooting instructions for
upgrades

## Type of change

- [ ] New feature, functionality or library
- [ ] Consensus breaking; add the `consensus-breaking` label if so. See
#791 for details
- [ ] Bug fix
- [ ] Code health or cleanup
- [x] Documentation
- [ ] Other (specify)
  • Loading branch information
Olshansk authored Feb 11, 2025
1 parent c627358 commit 2011ab6
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 8 deletions.
28 changes: 20 additions & 8 deletions docusaurus/docs/operate/upgrades/release_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ sidebar_position: 4

- [1. Determine if the Release is Consensus-Breaking](#1-determine-if-the-release-is-consensus-breaking)
- [2. Create a GitHub Release](#2-create-a-github-release)
- [Legend](#legend)
- [3. Write an Upgrade Plan](#3-write-an-upgrade-plan)
- [4. Issue Upgrade on TestNet](#4-issue-upgrade-on-testnet)
- [5. Issue Upgrade on MainNet](#5-issue-upgrade-on-mainnet)
- [3. Update the homebrew-tap formula](#3-update-the-homebrew-tap-formula)
- [4. Write an Upgrade Plan](#4-write-an-upgrade-plan)
- [5. Issue Upgrade on TestNet](#5-issue-upgrade-on-testnet)
- [6. Issue Upgrade on MainNet](#6-issue-upgrade-on-mainnet)

:::info
This document is for the Pocket Network protocol team's internal use only.
Expand Down Expand Up @@ -67,14 +67,26 @@ such as https://github.com/pokt-network/poktroll/blob/main/app/upgrades/historic
<!-- GitHub Release Notes continue here -->
```

#### Legend
**Legend**:

- ✅ - Yes
- ❌ - No
- ❓ - Unknown/To Be Determined
- ⚠️ - Warning/Caution Required

### 3. Write an Upgrade Plan
### 3. Update the homebrew-tap formula

```bash
git clone [email protected]:pokt-network/homebrew-poktroll.git
cd homebrew-poktroll
make tap_update_version
git commit -am "Update poktroll tap from v.X1.Y1.Z1 to vX1.Y2.Z2
git push
```
See the [poktrolld CLI docs](../../tools/user_guide/poktrolld_cli.md) for more information.
### 4. Write an Upgrade Plan
Protocol upgrades are only necessary for `consensus-breaking` changes. However, we can still issue an upgrade transaction to require Full Nodes and Validators to use a new version.
Expand All @@ -90,12 +102,12 @@ You can use the following template as a starting point.
- [ ] Prepare a contingency plan to address potential issues.
```
### 4. Issue Upgrade on TestNet
### 5. Issue Upgrade on TestNet
- Follow the [Upgrade Procedure](./upgrade_procedure.md) to upgrade existing/running Full Nodes and Validators to the new version of `poktroll`.
- Monitor the network's health metrics to identify any significant changes, such as the loss of many validators due to an unexpected consensus-breaking change.
### 5. Issue Upgrade on MainNet
### 6. Issue Upgrade on MainNet
- Repeat the upgrade process on the MainNet, following the same steps as on the TestNet.
- Ensure that the upgrade height is set correctly and communicated to the community.
Expand Down
22 changes: 22 additions & 0 deletions docusaurus/docs/tools/user_guide/poktrolld_cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ brew install poktrolld

- [MacOS \& Linux Users](#macos--linux-users)
- [Using Homebrew](#using-homebrew)
- [Troubleshooting Homebrew](#troubleshooting-homebrew)
- [From Source](#from-source)
- [Installing dependencies](#installing-dependencies)
- [Installing poktrolld](#installing-poktrolld)
Expand Down Expand Up @@ -48,6 +49,27 @@ repository for details on how to install homebrew or other details to install
or debug the CLI.
:::

#### Troubleshooting Homebrew

The source code for the Homebrew formula is available in the [homebrew-poktroll](https://github.com/pokt-network/homebrew-poktroll) repository.

If you encounter any issues, like being unable to install the latest version, you can try the following:

```bash
brew update
brew upgrade poktrolld
```

Or as a last resort, you can try the following:

```bash
brew tap --repair
brew untap pokt-network/poktroll
brew uninstall poktrolld
brew tap pokt-network/poktroll
brew install poktrolld
```

### From Source

#### Installing dependencies
Expand Down

0 comments on commit 2011ab6

Please sign in to comment.