fd812ee954
Co-authored-by: futreall <86553580+futreall@users.noreply.github.com> Co-authored-by: Marco <wudmytrotest200@gmail.com> Co-authored-by: Dmitry <98899785+mdqst@users.noreply.github.com> Co-authored-by: Dmytrol <46675332+Dimitrolito@users.noreply.github.com> Co-authored-by: Noisy <125606576+donatik27@users.noreply.github.com> Co-authored-by: Danil <37103154+Danyylka@users.noreply.github.com> Co-authored-by: CrazyFrog <anna.shuraeva13@gmail.com> Co-authored-by: Bryer <0xbryer@gmail.com> Co-authored-by: Viktor Pavlik <160131789+Vikt0rPavlik@users.noreply.github.com> Co-authored-by: Skylar Ray <137945430+sky-coderay@users.noreply.github.com> Co-authored-by: Brawn <nftdropped@gmail.com> Co-authored-by: fuder.eth <139509124+vtjl10@users.noreply.github.com> Co-authored-by: FT <140458077+zeevick10@users.noreply.github.com> Co-authored-by: Ann Wagner <chant_77_swirly@icloud.com> Co-authored-by: Hopium <135053852+Hopium21@users.noreply.github.com> Co-authored-by: Arr00 <13561405+arr00@users.noreply.github.com> Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>
46 lines
1.8 KiB
Markdown
46 lines
1.8 KiB
Markdown
# Releasing
|
|
|
|
OpenZeppelin Contracts uses a fully automated release process that takes care of compiling, packaging, and publishing the library, all of which is carried out in a clean CI environment (GitHub Actions), implemented in the ([`release-cycle`](.github/workflows/release-cycle.yml)) workflow. This helps to reduce the potential for human error and inconsistencies, and ensures that the release process is ongoing and reliable.
|
|
|
|
## Changesets
|
|
|
|
[Changesets](https://github.com/changesets/changesets/) are used as part of our release process for `CHANGELOG.md` management. Each change that is relevant for the codebase is expected to include a changeset.
|
|
|
|
## Branching model
|
|
|
|
The release cycle happens on release branches called `release-vX.Y`. Each of these branches starts as a release candidate (rc) and is eventually promoted to final.
|
|
|
|
A release branch can be updated with cherry-picked patches from `master`, or may sometimes be committed to directly in the case of old releases. These commits will lead to a new release candidate or a patch increment depending on the state of the release branch.
|
|
|
|
```mermaid
|
|
%%{init: {'gitGraph': {'mainBranchName': 'master'}} }%%
|
|
gitGraph
|
|
commit id: "Feature A"
|
|
commit id: "Feature B"
|
|
branch release-vX.Y
|
|
commit id: "Start release"
|
|
commit id: "Release vX.Y.0-rc.0"
|
|
|
|
checkout master
|
|
commit id: "Feature C"
|
|
commit id: "Fix A"
|
|
|
|
checkout release-vX.Y
|
|
cherry-pick id: "Fix A" tag: ""
|
|
commit id: "Release vX.Y.0-rc.1"
|
|
commit id: "Release vX.Y.0"
|
|
|
|
checkout master
|
|
merge release-vX.Y
|
|
commit id: "Feature D"
|
|
commit id: "Patch B"
|
|
|
|
checkout release-vX.Y
|
|
cherry-pick id: "Patch B" tag: ""
|
|
commit id: "Release vX.Y.1"
|
|
|
|
checkout master
|
|
merge release-vX.Y
|
|
commit id: "Feature E"
|
|
```
|