This is an automated email from the ASF dual-hosted git repository.
xuanwo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-opendal.git
The following commit(s) were added to refs/heads/main by this push:
new 1b3b20ee4 docs: Update Release Process (#2964)
1b3b20ee4 is described below
commit 1b3b20ee4665f9aff17be07ff3e27bd8249b645b
Author: Xuanwo <[email protected]>
AuthorDate: Tue Aug 29 13:55:12 2023 +0800
docs: Update Release Process (#2964)
Signed-off-by: Xuanwo <[email protected]>
---
website/docs/contributing/committer.md | 3 +-
website/docs/contributing/release.md | 60 +++++++++++++++++++++++++---------
2 files changed, 47 insertions(+), 16 deletions(-)
diff --git a/website/docs/contributing/committer.md
b/website/docs/contributing/committer.md
index ca64c9032..b0dbce766 100644
--- a/website/docs/contributing/committer.md
+++ b/website/docs/contributing/committer.md
@@ -1,5 +1,5 @@
---
-title: New Committer Landing Guide
+title: Committer Onboarding
sidebar_position: 3
---
@@ -76,6 +76,7 @@ Here's an illustration for Gmail users:
If you receive an email with the subject "WELCOME to [email protected]",
you have successfully subscribed to the mailing list.
## Setup 1password
+
OpenDAL offers a 1password open source team license for conducting local
integration tests (Thanks to 1Password!). Once you have been added to OpenDAL's
committer list, one of the PPMC members will invite you to join the team.
Please download your preferred clients to begin using it. Here are some
important notes regarding the use of 1Password:
diff --git a/website/docs/contributing/release.md
b/website/docs/contributing/release.md
index c13901423..aa96736f3 100644
--- a/website/docs/contributing/release.md
+++ b/website/docs/contributing/release.md
@@ -28,6 +28,34 @@ This section is the requirements for the release manager who
is the first time t
Refer to [Setup GPG Key](reference/setup_gpg.md) to make sure the GPG key has
been set up.
+## Start discussion about the next release
+
+Start a discussion about the next release via sending email to:
<[email protected]>:
+
+Title:
+
+```
+[DISCUSS] Release Apache OpenDAL(incubating) ${release_version}
+```
+
+Content:
+
+```
+Hello, Apache OpenDAL(incubating) Community,
+
+This is a call for a discussion to release Apache OpenDAL(incubating) version
${opendal_version}.
+
+The change lists about this release:
+
+https://github.com/apache/incubator-opendal/compare/v0.39.0...main
+
+Please leave your comments here about this release plan. We will bump the
version in repo and start the release process after the discussion.
+
+Thanks
+
+${name}
+```
+
## GitHub Release
### Bump Version
@@ -213,7 +241,7 @@ After at least 3 +1 binding vote (from OpenDAL Podling PMC
member and committers
Title:
```
-[Result][VOTE] Release Apache OpenDAL(incubating) ${release_version} - OpenDAL
Vote Round 1
+[RESULT][VOTE] Release Apache OpenDAL(incubating) ${release_version} - OpenDAL
Vote Round 1
```
Content:
@@ -354,6 +382,20 @@ Example:
<https://lists.apache.org/thread/h3x9pq1djpg76q3ojpqmdr3d0o03fld1>
## Official Release
+### Push the release git tag
+
+- `opendal_version`: the version for opendal, like `0.36.0`.
+- `release_version`: the version for the passed candidate, like `0.36.0-rc1`.
+
+```shell
+# Checkout the tags that passed VOTE
+git checkout ${release_version}
+# Tag with the opendal version
+git tag -s ${opendal_version}
+# Push tags to github to trigger releases
+git push origin ${opendal_version}
+```
+
### Publish artifacts to SVN RELEASE branch
- `opendal_version`: the version for opendal, like `0.36.0`.
@@ -362,25 +404,13 @@ Example:
<https://lists.apache.org/thread/h3x9pq1djpg76q3ojpqmdr3d0o03fld1>
```shell
svn mv
https://dist.apache.org/repos/dist/dev/incubator/opendal/${release_version}
https://dist.apache.org/repos/dist/release/incubator/opendal/${opendal_version}
-m "Release ${opendal_version}"
```
+
### Change OpenDAL Website download link
+
Change the
[download](https://github.com/apache/incubator-opendal/blob/main/website/src/pages/download.md)
link in the website to the new release version.
Take [Add 0.39.0 release link to
download.md](https://github.com/apache/incubator-opendal/pull/2882) as an
example.
-
-### Push the release Git tag
-
-- `opendal_version`: the version for opendal, like `0.36.0`.
-- `release_version`: the version for the passed candidate, like `0.36.0-rc1`.
-
-Check out the passed release candidate, tag an alias and push.
-
-```shell
-git checkout ${release_version}
-git tag -s ${opendal_version}
-git push origin ${opendal_version}
-```
-
### Release Maven artifacts
- `maven_artifact_number`: the number for Maven staging artifacts, like `1010`.
