From 8287495954841eac07a7af6b1ab9f32c567db1b6 Mon Sep 17 00:00:00 2001 From: Xuanwo Date: Thu, 21 Sep 2023 10:43:43 +0800 Subject: [PATCH 1/2] docs: Add start tracking issues about the next release Signed-off-by: Xuanwo --- website/docs/contributing/release.md | 76 ++++++++++++++++++++++------ 1 file changed, 60 insertions(+), 16 deletions(-) diff --git a/website/docs/contributing/release.md b/website/docs/contributing/release.md index ef4d7ec3515b..8348f93c700e 100644 --- a/website/docs/contributing/release.md +++ b/website/docs/contributing/release.md @@ -56,24 +56,66 @@ 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. + +### Github Side -Take [Bump to version 0.36.0](https://github.com/apache/incubator-opendal/pull/2366) as an example. +- [ ] Bump version in project + - [ ] rust + - [ ] cpp + - [ ] haskell + - [ ] java + - [ ] nodejs +- [ ] Update docs +- [ ] Push release candidate tag to GitHub + +### ASF Side + +- [ ] Create an ASF Release +- [ ] Start VOTE at opendal community +- [ ] Start VOTE at incubator community +- [ ] Send annouance + +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 +130,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 +266,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 +377,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 From e976b907cb528ed12e991442b01c13caf2f2b818 Mon Sep 17 00:00:00 2001 From: Xuanwo Date: Thu, 21 Sep 2023 10:49:20 +0800 Subject: [PATCH 2/2] Update content Signed-off-by: Xuanwo --- website/docs/contributing/release.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/website/docs/contributing/release.md b/website/docs/contributing/release.md index 8348f93c700e..6ed7f9bc53b6 100644 --- a/website/docs/contributing/release.md +++ b/website/docs/contributing/release.md @@ -77,7 +77,9 @@ This issue is used to track tasks of the opendal ${opendal_version} release. > Blockers are the tasks that must be completed before the release. -### Github Side +### Build Release + +#### GitHub Side - [ ] Bump version in project - [ ] rust @@ -88,12 +90,24 @@ This issue is used to track tasks of the opendal ${opendal_version} release. - [ ] Update docs - [ ] Push release candidate tag to GitHub -### ASF Side +#### ASF Side - [ ] 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 -- [ ] Send annouance + +### 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 ```