You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@opendal.apache.org by xu...@apache.org on 2023/09/21 03:00:47 UTC
[incubator-opendal] branch main updated: docs: Add start tracking issues about the next release (#3145)
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 7e5450184 docs: Add start tracking issues about the next release (#3145)
7e5450184 is described below
commit 7e5450184a017844953dd28827cb7ac50a05b430
Author: Xuanwo <gi...@xuanwo.io>
AuthorDate: Thu Sep 21 11:00:43 2023 +0800
docs: Add start tracking issues about the next release (#3145)
* docs: Add start tracking issues about the next release
Signed-off-by: Xuanwo <gi...@xuanwo.io>
* Update content
Signed-off-by: Xuanwo <gi...@xuanwo.io>
---------
Signed-off-by: Xuanwo <gi...@xuanwo.io>
---
website/docs/contributing/release.md | 90 +++++++++++++++++++++++++++++-------
1 file changed, 74 insertions(+), 16 deletions(-)
diff --git a/website/docs/contributing/release.md b/website/docs/contributing/release.md
index ef4d7ec35..6ed7f9bc5 100644
--- a/website/docs/contributing/release.md
+++ b/website/docs/contributing/release.md
@@ -56,24 +56,80 @@ Thanks
${name}
```
-## GitHub Release
+## Start tracking issues about the next release
-### Bump Version
+Start a tracking issue on Github for the upcoming release to track all tasks that need to be completed.
-OpenDAL will release all packages in the same version.
+Title:
-- Bump version in `Cargo.toml`.
-- For the nodejs binding, bump version in `bindings/nodejs/package.json` and `bindings/nodejs/npm/*/package.json`.
-- For the java binding, bump version in `bindings/java/pom.xml`.
-- For the cpp binding, bump version in `bindings/cpp/CMakeLists.txt`.
-- For the haskell binding, bump version and update the `tag` field of `source-repository this` in `bindings/haskell/opendal.cabal`.
-- Update `CHANGELOG.md`, refer to [Generate Release Note](reference/generate_release_note.md) for more information.
-- If there are breaking changes in `core`, please also update `core/src/docs/upgrade.md`.
-- After all those changes, submit a PR with name `Bump to version x.y.z`.
+```
+Tracking issuses of OpenDAL ${opendal_version} Release
+```
+
+Content:
+
+```markdown
+This issue is used to track tasks of the opendal ${opendal_version} release.
+
+## Tasks
+
+### Blockers
+
+> Blockers are the tasks that must be completed before the release.
+
+### Build Release
+
+#### GitHub Side
+
+- [ ] Bump version in project
+ - [ ] rust
+ - [ ] cpp
+ - [ ] haskell
+ - [ ] java
+ - [ ] nodejs
+- [ ] Update docs
+- [ ] Push release candidate tag to GitHub
+
+#### ASF Side
-Take [Bump to version 0.36.0](https://github.com/apache/incubator-opendal/pull/2366) as an example.
+- [ ] Create an ASF Release
+- [ ] Upload artifacts to the SVN dist repo
+- [ ] Close the Nexus staging repo
+
+### Voting
+
+- [ ] Start VOTE at opendal community
+- [ ] Start VOTE at incubator community
+
+### Official Release
+
+- [ ] Push the release git tag
+- [ ] Publish artifacts to SVN RELEASE branch
+- [ ] Change OpenDAL Website download link
+- [ ] Release Maven artifacts
+- [ ] Send the announcement
+
+For details of each steps, please refer to: https://opendal.apache.org/docs/contributing/release
+```
+
+## GitHub Side
+
+### Bump version in project
+
+Bump all version in the project to the new opendal version. Please note that this version is the exact version of the release, not the release candidate version.
+
+- rust core: bump version in `Cargo.toml`
+- cpp binding: bump version in `bindings/cpp/CMakeLists.txt`
+- haskell binding: bump version and update the `tag` field of `source-repository this` in `bindings/haskell/opendal.cabal`
+- java binding: bump version in `bindings/java/pom.xml`
+- nodejs binding: bump version in `bindings/nodejs/package.json` and `bindings/nodejs/npm/*/package.json`
+
+### Update docs
+
+- Update `CHANGELOG.md`, refer to [Generate Release Note](reference/generate_release_note.md) for more information.
+- Update `core/src/docs/upgrade.md` if there are breaking changes in `core`
-### Create a GitHub Release
+### Push release candidate tag
After bump version PR gets merged, we can create a GitHub release:
@@ -88,7 +144,7 @@ Pushing a Git tag to GitHub repo will trigger a GitHub Actions workflow that cre
:::
-## ASF Release
+## ASF Side
If any step in the ASF Release process fails and requires code changes,
we will abandon that version and prepare for the next one.
@@ -224,7 +280,8 @@ https://repository.apache.org/content/repositories/orgapacheopendal-${maven_arti
Please download, verify, and test.
-The VOTE will pass after got 3 binding approve.
+The VOTE will be open for at least 72 hours and until the necessary
+number of votes are reached.
[ ] +1 approve
[ ] +0 no opinion
@@ -334,7 +391,8 @@ https://repository.apache.org/content/repositories/orgapacheopendal-${maven_arti
Please download, verify, and test.
-The VOTE will pass after got 3 binding approve.
+The VOTE will be open for at least 72 hours and until the necessary
+number of votes are reached.
[ ] +1 approve
[ ] +0 no opinion