Skip to content

Commit

Permalink
Merge pull request #2279 from ethereum-optimism/sc/rename-regenesis-r…
Browse files Browse the repository at this point in the history
…elease

maint: use release instead of regenesis branches
  • Loading branch information
mslipper authored Mar 8, 2022
2 parents a68097c + db0e585 commit 0f042da
Show file tree
Hide file tree
Showing 10 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/batch-submitter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
- 'master'
- 'develop'
- '*rc'
- 'regenesis/*'
- 'release/*'
pull_request:
branches:
- '*'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/bss-core.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
- 'master'
- 'develop'
- '*rc'
- 'regenesis/*'
- 'release/*'
pull_request:
branches:
- '*'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/gas-oracle.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
- 'master'
- 'develop'
- '*rc'
- 'regenesis/*'
- 'release/*'
pull_request:
branches:
- '*'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/geth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
- 'master'
- 'develop'
- '*rc'
- 'regenesis/*'
- 'release/*'
pull_request:
paths:
- 'l2geth/**'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/golangci-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ on:
- 'master'
- 'develop'
- '*rc'
- 'regenesis/*'
- 'release/*'
pull_request:
branches:
- '*'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/integration.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
- 'master'
- 'develop'
- '*rc'
- 'regenesis/*'
- 'release/*'
pull_request:
workflow_dispatch:

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/teleportr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
- 'master'
- 'develop'
- '*rc'
- 'regenesis/*'
- 'release/*'
pull_request:
branches:
- '*'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ts-packages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
- 'master'
- 'develop'
- '*rc'
- 'regenesis/*'
- 'release/*'
pull_request:
workflow_dispatch:

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Note that we have a [Code of Conduct](https://github.com/ethereum-optimism/.gith

In general, the smaller the diff the easier it will be for us to review quickly.

In order to contribute, fork the appropriate branch, for non-breaking changes to production that is `develop` and for the next regenesis release that is normally `regenesis...` branch, see [details about our branching model](https://github.com/ethereum-optimism/optimism/blob/develop/README.md#branching-model-and-releases).
In order to contribute, fork the appropriate branch, for non-breaking changes to production that is `develop` and for the next release that is normally `release/X.X.X` branch, see [details about our branching model](https://github.com/ethereum-optimism/optimism/blob/develop/README.md#branching-model-and-releases).

Additionally, if you are writing a new feature, please ensure you add appropriate test cases.

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ root
| Branch | Status |
| --------------- | -------------------------------------------------------------------------------- |
| [master](https://github.com/ethereum-optimism/optimism/tree/master/) | Accepts PRs from `develop` when we intend to deploy to mainnet. |
| [develop](https://github.com/ethereum-optimism/optimism/tree/develop/) | Accepts PRs that are compatible with `master` OR from `regenesis/X.X.X` branches. |
| regenesis/X.X.X | Accepts PRs for all changes, particularly those not backwards compatible with `develop` and `master`. |
| [develop](https://github.com/ethereum-optimism/optimism/tree/develop/) | Accepts PRs that are compatible with `master` OR from `release/X.X.X` branches. |
| release/X.X.X | Accepts PRs for all changes, particularly those not backwards compatible with `develop` and `master`. |

### Overview

Expand Down Expand Up @@ -90,10 +90,10 @@ Be sure to not merge other pull requests into `develop` if partially through the

### Release candidate branches

Branches marked `regenesis/X.X.X` are **release candidate branches**.
Branches marked `release/X.X.X` are **release candidate branches**.
Changes that are not backwards compatible and all changes to contracts within `packages/contracts/contracts` MUST be directed towards a release candidate branch.
Release candidates are merged into `develop` and then into `master` once they've been fully deployed.
We may sometimes have more than one active `regenesis/X.X.X` branch if we're in the middle of a deployment.
We may sometimes have more than one active `release/X.X.X` branch if we're in the middle of a deployment.
See table in the **Active Branches** section above to find the right branch to target.

### Releasing new versions
Expand Down

0 comments on commit 0f042da

Please sign in to comment.