ca7a4e39de
Co-authored-by: Bilog WEB3 <155262265+Bilogweb3@users.noreply.github.com> Co-authored-by: Fallengirl <155266340+Fallengirl@users.noreply.github.com> Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com> Co-authored-by: XxAlex74xX <30472093+XxAlex74xX@users.noreply.github.com> Co-authored-by: Arr00 <13561405+arr00@users.noreply.github.com> Co-authored-by: PixelPilot <161360836+PixelPil0t1@users.noreply.github.com> Co-authored-by: kilavvy <140459108+kilavvy@users.noreply.github.com> Co-authored-by: Devkuni <155117116+detrina@users.noreply.github.com> Co-authored-by: Danbo <140512416+dannbbb1@users.noreply.github.com> Co-authored-by: Ann Wagner <chant_77_swirly@icloud.com> Co-authored-by: comfsrt <155266597+comfsrt@users.noreply.github.com> Co-authored-by: Bob <158583129+bouchmann@users.noreply.github.com> Co-authored-by: JohnBonny <158583902+JohnBonny@users.noreply.github.com> Co-authored-by: moonman <155266991+moooonman@users.noreply.github.com> Co-authored-by: kazak <alright-epsilon8h@icloud.com> Co-authored-by: Wei <ybxerlvqtx@rambler.ru> Co-authored-by: Maxim Evtush <154841002+maximevtush@users.noreply.github.com> Co-authored-by: Vitalyr <158586577+Vitaliyr888@users.noreply.github.com> Co-authored-by: pendrue <158588659+pendrue@users.noreply.github.com> Co-authored-by: Tronica <wudmytrotest404@gmail.com> Co-authored-by: emmmm <155267286+eeemmmmmm@users.noreply.github.com> Co-authored-by: bigbear <155267841+aso20455@users.noreply.github.com> Co-authored-by: Tomás Andróil <tomasandroil@gmail.com> Co-authored-by: GooseMatrix <155266802+GooseMatrix@users.noreply.github.com> Co-authored-by: jasmy <3776356370@qq.com> Co-authored-by: SITADRITA1 <mrlime2018@gmail.com> Co-authored-by: Ocenka <testoviydiman1@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 consistent 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"
|
|
```
|