From 0e7d2b2f37c2ff5c48f516f86da496f1884322fe Mon Sep 17 00:00:00 2001 From: Samuel Stokes Date: Thu, 13 Mar 2025 14:18:05 -0400 Subject: [PATCH 1/2] op-deployer: add backport example to devdoc --- .../book/src/reference-guide/releases.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/op-deployer/book/src/reference-guide/releases.md b/op-deployer/book/src/reference-guide/releases.md index b53591a863c13..4fdb69729ae9c 100644 --- a/op-deployer/book/src/reference-guide/releases.md +++ b/op-deployer/book/src/reference-guide/releases.md @@ -22,11 +22,24 @@ From time to time, we may backport bugfixes from develop onto earlier versions o as follows: 1. If one doesn't exist already, make a new branch for the version lineage you're patching (e.g. `v0.2.x`). This branch - should be based on the latest release of that lineage. The branch should be named as follows: + should be protected (not deletable) and should be based on the latest release of that lineage. The branch should be named as follows: `backports/op-deployer/`. 2. Open a PR with the backport against that branch. Be sure to reference the original commit in the backport. 3. Make and push a new tag on that lineage. +Example for backporting fix(es) from `develop` and created a new release `op-deployer/v0.2.1`: +``` +git checkout -b backports/op-deployer/v0.2.0 op-deployer/v0.2.0 +git push origin backports/op-deployer/v0.2.0 +git checkout -b op-deployer/v0.2.1 backports/op-deployer/v0.2.0 +git cherry-pick +git push origin op-deployer/v0.2.1 + +// open pr from op-deployer/v0.2.1 targeting backports/op-deployer/v0.2.0 +// merge the pr +// create a new op-deployer/v0.2.1 tag on backports/op-deployer/v0.2.0 branch +``` + ## Adding Support for New Contract Versions Adding support for a new contract version is a multi-step process. Here's a high-level overview. For the sake of @@ -67,7 +80,7 @@ const ContractsVXTag = "op-contracts/vX.Y.Z" var taggedReleases = map[string]TaggedRelease{ // Other releases... ContractsVXTag: { - ArtifactsHash: common.HexToHash(""), + ArtifactsHash: common.HexToHash(""), ContentHash: common.HexToHash(""), }, } @@ -93,4 +106,4 @@ root of the monorepo: go get -u github.com/ethereum-optimism/superchain-registry/validation@ ``` -That should be it! \ No newline at end of file +That should be it! From 05c7cf50ee4897081165be9d716d95d3166db8e6 Mon Sep 17 00:00:00 2001 From: Samuel Stokes Date: Mon, 17 Mar 2025 10:16:16 -0400 Subject: [PATCH 2/2] clear up wording in release docs --- op-deployer/book/src/reference-guide/releases.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/op-deployer/book/src/reference-guide/releases.md b/op-deployer/book/src/reference-guide/releases.md index 4fdb69729ae9c..bbbc90b5f847f 100644 --- a/op-deployer/book/src/reference-guide/releases.md +++ b/op-deployer/book/src/reference-guide/releases.md @@ -31,13 +31,13 @@ Example for backporting fix(es) from `develop` and created a new release `op-dep ``` git checkout -b backports/op-deployer/v0.2.0 op-deployer/v0.2.0 git push origin backports/op-deployer/v0.2.0 -git checkout -b op-deployer/v0.2.1 backports/op-deployer/v0.2.0 +git checkout -b fixes/deployer-v0.2.0 backports/op-deployer/v0.2.0 git cherry-pick -git push origin op-deployer/v0.2.1 +git push origin fixes/deployer-v0.2.0 -// open pr from op-deployer/v0.2.1 targeting backports/op-deployer/v0.2.0 -// merge the pr -// create a new op-deployer/v0.2.1 tag on backports/op-deployer/v0.2.0 branch +1. open pr from fixes/deployer-v0.2.0 targeting backports/op-deployer/v0.2.0 +2. merge the pr +3. push a new tag for op-deployer/v0.2.1 on backports/op-deployer/v0.2.0 branch (goreleaser will create the release) ``` ## Adding Support for New Contract Versions