Fix smart contracts release process docs - #2139
Conversation
…move deprecated networks
|
Picked this up while triaging the open queue. The fixes are real and still needed — I verified the two external claims:
The problem is the base, not the change. This branch is from February and main has moved past it in four places, so merging as-is would revert them:
The Baklava/Alfajores → Celo Sepolia edits are also already on main via #2175. And if you rebase this branch you get a real defect that is not in either version: T+2w and T+3w both end up saying "deploy the contracts to Celo Sepolia", because the old two-testnet ladder collapses onto a table main has already restructured correctly. Rather than ask you to untangle a six-month-old rebase, I opened #2295 with only the parts main still needs, on current main, with you as co-author. It also makes each bash block self-contained (six of them referenced @martinvol — one thing I could not verify and would like your eyes on: the flag and generated-filename changes ( Suggest closing this in favour of #2295 once you are happy with it. |
|
Closing in favour of #2295, which carries this work rebuilt on current main with you as co-author. To be clear about what is being closed: the bugs you found were real and are all fixed in #2295. Verified against celo-org/celo-monorepo before porting them:
What could not be salvaged was the base. Opened in February, main has moved past it in four places, so merging as-is would have reverted them: the #2295 additionally makes each bash block self-contained: six of them referenced @martinvol — the one part I took on trust and would like you to check on #2295 is the flag and generated-filename set ( |
…ale release-script flags Supersedes #2139, which was opened in February and has since diverged from main: merging it as-is would revert four fixes main has picked up (the `description` frontmatter, the pinned celo-monorepo setup link, the OpenZeppelin proxies link, and the anvil network option). This applies only the parts of #2139 that main still needs, on top of current main. Verified against celo-org/celo-monorepo: - `packages/what-is-celo/about-celo-l1/protocol/releaseData/` 404s — a bad find-and-replace from an old docs migration. The real path is `packages/protocol/releaseData/initializationData/`, which exists. - `.circleci/` 404s; the repo moved to GitHub Actions. `RELEASE_TAG` is defined at `.github/workflows/celo-monorepo.yml:32`. Bash that could not run: - `${N-1}` is parameter expansion with a default, not arithmetic — it evaluates to "N" whenever N is unset, so `PREVIOUS_RELEASE` came out as `core-contracts.vN`. Now `$((N-1))`. - `NETWORK=${"anvil"|"celo-sepolia"|"mainnet"}` is a syntax error. Now a real assignment with the options in a comment. - Six blocks used `$N`, `$PREVIOUS_RELEASE`, `$RELEASE_CANDIDATE` or `$PRIVATE_KEY` without defining them. Each block now stands alone (AGENTS.md section 5). The examples use N=18, the next release after the `core-contracts.v17` currently pinned in the workflow. Release script flags and outputs brought in line with the current implementation: `-r`/`-p` no longer name files that the scripts write themselves, `-k` is required by `release:make`, and the generated filenames (`report-*`, `*-libraries.json`, `proposal-*`) are stated where they are produced and used. Also drops the `export const N = "N"` Docusaurus leftover and three typos (Vaildator, valildator, EXCECUTED). Verified: `mintlify broken-links` reports no broken links. Co-Authored-By: martinvol <martinvol@users.noreply.github.com> Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Summary
-rand-pdeprecated, libraries file renamed)${N-1}→$((N-1))for arithmetic, remove MDXexport const Nworkaroundpackages/what-is-celo/about-celo-l1/protocol/releaseData/→packages/protocol/releaseData/.circleci/config.ymlreferences to.github/workflows/celo-monorepo.yml