Skip to content

Commit 2613863

Browse files
authored
Minor clarifications about the release process
1 parent 5ee2a1c commit 2613863

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

docs/process/release.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
### Update the Replica Version
66

77
Click the "Run workflow" button on the [Update Replica page](https://github.com/dfinity/sdk/actions/workflows/update-replica-version.yml) workflow.
8+
This will create a new PR.
9+
Incorporate the suggested changes to CHANGELOG.md in the PR branch. To this end, copy the section `## Dependencies`, if not present already, and `## Replica`, including all proposals that have not been listed in the previous release.
810

911
Obtain approval and merge the PR.
1012

@@ -15,14 +17,14 @@ new dfx version underneath the "# Unreleased" header. Further changes to dfx
1517
should be added under the "#Unreleased" header, unless they are ported to
1618
the release branch.
1719

20+
If you create a new patch version, make sure there will be no breaking changes included.
21+
1822
[Sample PR](https://github.com/dfinity/sdk/pull/3486)
1923

2024
### Create the Release Branch
2125

2226
Create a release branch from `master`, for example `release-0.15.3`.
2327

24-
If you create a new patch version make sure there will be no breaking changes included.
25-
2628
This branch will be used to create beta releases as well as the final release.
2729

2830
## Stage 2: Beta releases - day 1 ~ 2
@@ -32,9 +34,9 @@ This branch will be used to create beta releases as well as the final release.
3234
It will:
3335
- Build `dfx` from clean;
3436
- Validate the default project interactively;
35-
- Create a beta release branch which update the version number in manifest files and push to GitHub;
37+
- Create a beta release branch, which updates the version number in the manifest files, and then push to GitHub;
3638
- Wait for you to:
37-
- Create a PR from the new branch to the release branch,
39+
- Create a PR from the beta release branch to the release branch,
3840
e.g. into `release-0.15.3` from `adam/release-0.15.3-beta.0`;
3941
- Obtain approval and merge the PR;
4042
- Push a tag which triggers the [publish][publish-workflow] workflow;
@@ -49,7 +51,7 @@ This branch will be used to create beta releases as well as the final release.
4951
> dfxvm install 0.15.3-beta.1
5052
> ```
5153
>
52-
> See also release notes.
54+
> See also the release notes.
5355
1. Post a message to the forum about availability of the not-yet-promoted beta, linking to the GitHub release notes.
5456
5557
[Sample PR](https://github.com/dfinity/sdk/pull/3477)

0 commit comments

Comments
 (0)