-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Update contracts release documentation #17719
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+57
−41
Merged
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
7899ff6
Remove empty code-freezes page
maurelian 4797795
Add release-process.md
maurelian 1704247
Update packages/contracts-bedrock/book/src/policies/release-process.md
maurelian 028a22f
Apply suggestions from code review
maurelian 04c7e45
Update packages/contracts-bedrock/book/src/policies/release-process.md
maurelian ed096fd
Update packages/contracts-bedrock/book/src/policies/release-process.md
maurelian a61c444
Update packages/contracts-bedrock/book/src/SUMMARY.md
maurelian c5d4ea2
Use real numbers in <ol>
maurelian f16dc17
Update release-process.md
maurelian 03a352b
Clarify that semver bump on develop applies to modified contracts
maurelian File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 change: 0 additions & 1 deletion
1
packages/contracts-bedrock/book/src/contributing/code-freezes.md
maurelian marked this conversation as resolved.
Show resolved
Hide resolved
|
This file was deleted.
Oops, something went wrong.
56 changes: 56 additions & 0 deletions
56
packages/contracts-bedrock/book/src/policies/release-process.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| # Tagging and Release Process | ||
|
|
||
| ## Creating a tagged release | ||
|
|
||
| First select a tag string based on the guidance in [Monorepo Contracts Release Versioning](./versioning.md#monorepo-contracts-release-versioning) | ||
|
|
||
| 1. Checkout the commit | ||
| 1. Run `git tag <tag-string>` | ||
| 1. Run `git push origin <tag-string>` | ||
maurelian marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| This may require special authorization. Once pushed a tag cannot be deleted, so please be sure it is correct. | ||
maurelian marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 1. Create release notes in Github: | ||
| - Go to the [Releases page](https://github.com/ethereum-optimism/optimism/releases), enter or select `<tag-string>` | ||
| from the dropdown. | ||
| 1. Populate the release notes. If the tag is a release candidate, check the `Set as a pre-release` option, and uncheck the | ||
| `Set as the latest release` option. | ||
| 1. Deploy the OPCM using the `op-deployer bootstrap implementations` [command](https://devdocs.optimism.io/op-deployer/user-guide/bootstrap.html), | ||
| this will write the addresses of the deployed contracts to `stdout` (or to disk if you provide an `--outfile` argument). | ||
| Do this on both Sepolia and Mainnet. | ||
| 1. In the superchain-registry edit the following files to add a new `[<tag-string>]` entry, with the addresses from the | ||
| previous step: | ||
| - [standard-versions-mainnet.toml](https://github.com/ethereum-optimism/superchain-registry/blob/main/validation/standard/standard-versions-mainnet.toml) | ||
| - [standard-versions-sepolia.toml](https://github.com/ethereum-optimism/superchain-registry/blob/main/validation/standard/standard-versions-sepolia.toml) | ||
| 1. Once the changes are merged into the superchain-registry, you can follow the [instructions](https://devdocs.optimism.io/op-deployer/reference-guide/releases.html#step-3-update-the-sr-with-the-new-release) | ||
| for creating a new release of `op-deployer`. | ||
|
|
||
| ## Implications for audits | ||
|
|
||
| The process above should be followed to create an `-rc.1` release prior to audit. This will be the target commit for | ||
| the audit. If any fixes are required by the audit results an Additional Release Candidate will be required. | ||
|
|
||
| ## Additional Release Candidates | ||
|
|
||
| Sometimes fixes or additional changes need to be added to a release candidate version. In that case | ||
| we want to ensure fixes are made on both the release and the trunk branch, without stopping development | ||
| efforts on the trunk branch. | ||
|
|
||
| The process is as follows: | ||
|
|
||
| 1. Make the fixes on `develop`. Increment the contracts semver as normal. | ||
| 1. Create a new release branch, named `proposal/op-contracts/X.Y.Z` off of the rc tag (all subsequent `-rc` tags | ||
maurelian marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| will be made from this branch). | ||
| 1. Cherry pick the fixes from `develop` into that branch. Instead of incrementing the semver as normal, | ||
| append `-patch.n` to the end of the version number. The value of `n` should start at 1 and be | ||
| incremented for each additional patch. This suffix prevents a situation where two different implementations of the same | ||
| contract have the same semver. | ||
maurelian marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 1. After merging the changes into the new release branch, tag the resulting commit on the proposal branch as `op-contracts/vX.Y.Z-rc.n`. | ||
| Create a new release for this tag per the instructions above. | ||
|
|
||
| ## Finalizing a release | ||
|
|
||
| Once a release has passed governance, a new tag should be created without the `-rc.n` suffix. To do this follow the | ||
| instructions in "Creating a tagged release" once again. It should not be necessary to redeploy the contracts with `op-deployer`, | ||
| but a new entry will be required in the superchain-registry's toml files regardless. | ||
| When creating release notes, _uncheck_ the `Set as a pre-release` option, and _check_ the | ||
| `Set as the latest release` option. | ||
maurelian marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.