Skip to content

Commit 6a99359

Browse files
committed
docs: Update upgrade guide
1 parent 40aaee4 commit 6a99359

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

scripts/upgrades/README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,41 @@
11
# PoCo Smart Contracts Upgrade Guide
22

3-
This document explains the recommended steps for creating and applying
4-
a safe, traceable, and reproducible upgrade to the PoCo Diamond proxy.
3+
This document explains the recommended steps for creating and applying a safe, traceable,
4+
and reproducible upgrade to the PoCo Diamond proxy.
55

66
## Upgrade Steps
77

88
0. **Ensure all tests pass**:<br>
99
Run the full test suite to make sure everything is working before starting an upgrade.
1010

1111
1. **Create a new upgrade script**:<br>
12-
Name the script using the version and upgrade name format: `vX.Y.Z-upgrade-name.ts`.
12+
Name the script using the version and upgrade name in the form `vX.Y.Z-upgrade-name.ts`
13+
and implement the upgrade logic.
1314

1415
2. **Create a corresponding Markdown report**:<br>
15-
Copy the template file `v0.0.0-template.md` and rename it to match the script: `vX.Y.Z-upgrade-name.md`.
16+
Copy the template file `v0.0.0-template.md` and rename it to match the script's name
17+
(`vX.Y.Z-upgrade-name.md`).
1618

17-
3. **Update GitHub Actions**:<br>
19+
3. **Test dry-runs locally**:<br>
20+
Use the script [./dry-run.sh](./dry-run.sh) and check the logs.
21+
22+
4. **Update GitHub Actions**:<br>
1823
Modify `upgrade-facets.yml` workflow to call the new upgrade script.
1924

20-
4. **Upgrade on Testnet**:
25+
5. **Upgrade on Testnet**:
2126
- ⚠️ Always upgrade on the testnet first.
2227
- Trigger the upgrade workflow on GitHub and choose the testnet network.
2328
- Start with a **dry run** to simulate the upgrade.
2429
- Once verified, apply the upgrade on the live testnet.
2530

26-
5. **Upgrade on Mainnet**:
31+
6. **Upgrade on Mainnet**:
2732
- Trigger the upgrade workflow on GitHub and choose the mainnet network.
2833
- Perform a dry run first.
2934
- Apply the upgrade on the mainnet.
3035
- Merge the artifacts PR after successful execution.
3136

32-
6. **Update upgrade report**:<br>
37+
7. **Update upgrade report**:<br>
3338
Fill in all required information in `vX.Y.Z-upgrade-name.ts` (tx hashes, logs, ...).
3439

35-
7. **Create a release**
40+
8. **Create a release**
3641
- Use **Release Please** to tag the upgrade version and create the release on GitHub.
37-
38-
39-
Following these steps ensures upgrades are **safe, traceable, and reproducible**.

0 commit comments

Comments
 (0)