Skip to content

Fix smart contracts release process docs - #2139

Closed
martinvol wants to merge 1 commit into
mainfrom
martinvol/fix-smart-contracts-release-docs
Closed

Fix smart contracts release process docs#2139
martinvol wants to merge 1 commit into
mainfrom
martinvol/fix-smart-contracts-release-docs

Conversation

@martinvol

Copy link
Copy Markdown
Contributor

Summary

  • Update release script flags to match current implementations (-r and -p deprecated, libraries file renamed)
  • Fix bash syntax: ${N-1}$((N-1)) for arithmetic, remove MDX export const N workaround
  • Fix incorrect path packages/what-is-celo/about-celo-l1/protocol/releaseData/packages/protocol/releaseData/
  • Update .circleci/config.yml references to .github/workflows/celo-monorepo.yml
  • Replace Baklava and Alfajores references with Celo Sepolia
  • Fix typos: "Vaildator", "valildator", "EXCECUTED"
  • Add notes about auto-generated output filenames for libraries, reports, and proposals

@GigaHierz

Copy link
Copy Markdown
Contributor

Picked this up while triaging the open queue. The fixes are real and still needed — I verified the two external claims:

$ gh api repos/celo-org/celo-monorepo/contents/packages/what-is-celo     -> 404
$ gh api repos/celo-org/celo-monorepo/contents/.circleci                 -> 404
$ gh api .../contents/.github/workflows/celo-monorepo.yml | grep RELEASE_TAG
32:  RELEASE_TAG: core-contracts.v17

packages/what-is-celo/about-celo-l1/protocol/releaseData/ is a docs-migration find-and-replace that landed in a source-tree path, and ${N-1} is parameter-expansion-with-default rather than arithmetic, so PREVIOUS_RELEASE has been resolving to core-contracts.vN this whole time.

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 $N / $PREVIOUS_RELEASE / $PRIVATE_KEY without defining them, so only the first block on the page was copy-pasteable).

@martinvol — one thing I could not verify and would like your eyes on: the flag and generated-filename changes (-r/-p dropped, -k added, report-* / *-libraries.json / proposal-* names). Those came from you and I took them as given rather than reading the release scripts.

Suggest closing this in favour of #2295 once you are happy with it.

@GigaHierz

Copy link
Copy Markdown
Contributor

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:

$ gh api repos/celo-org/celo-monorepo/contents/packages/what-is-celo   -> 404
$ gh api repos/celo-org/celo-monorepo/contents/.circleci               -> 404
$ gh api .../contents/.github/workflows/celo-monorepo.yml | grep RELEASE_TAG
32:  RELEASE_TAG: core-contracts.v17

packages/what-is-celo/about-celo-l1/protocol/releaseData/ was a docs-migration find-and-replace that landed in a source-tree path, and ${N-1} is parameter-expansion-with-default rather than arithmetic, so PREVIOUS_RELEASE has been resolving to core-contracts.vN for as long as the page has existed. Neither would have been caught without this PR.

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 og:descriptiondescription migration (#2239), the celo-monorepo setup link pinned to 045aa0061, the OpenZeppelin /1.x/proxies path, and the anvil network option. The Baklava/Alfajores → Celo Sepolia edits landed separately via #2175. Rebasing also produced a defect present in neither version — T+2w and T+3w both ending up as "deploy the contracts to Celo Sepolia", because the old two-testnet ladder collapses onto a table main had already restructured. As of today the branch is also conflicting.

#2295 additionally makes each bash block self-contained: six of them referenced $N, $PREVIOUS_RELEASE or $PRIVATE_KEY without defining them, so only the first block on the page was copy-pasteable.

@martinvol — the one part I took on trust and would like you to check on #2295 is the flag and generated-filename set (-r/-p dropped, -k added, report-* / *-libraries.json / proposal-*). Those came from you and I did not read the release scripts to confirm them.

@GigaHierz GigaHierz closed this Aug 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants