You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by yu...@apache.org on 2022/10/12 14:54:29 UTC
[incubator-devlake-website] branch main updated: fix: update the release guide
This is an automated email from the ASF dual-hosted git repository.
yumeng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
The following commit(s) were added to refs/heads/main by this push:
new 8c5a9dcfc fix: update the release guide
8c5a9dcfc is described below
commit 8c5a9dcfcc531155d6b2908a5a7af9cb93cc0cc0
Author: zhangliang <li...@merico.dev>
AuthorDate: Wed Oct 12 22:46:30 2022 +0800
fix: update the release guide
---
docs/DeveloperManuals/Release-SOP.md | 78 ++++++++++++++++++------------------
1 file changed, 40 insertions(+), 38 deletions(-)
diff --git a/docs/DeveloperManuals/Release-SOP.md b/docs/DeveloperManuals/Release-SOP.md
index 7e87bee37..e63f317f5 100644
--- a/docs/DeveloperManuals/Release-SOP.md
+++ b/docs/DeveloperManuals/Release-SOP.md
@@ -1,6 +1,6 @@
-# Devlake release guide
+# DevLake Release Guide
-**Please make sure your public key was included in the https://downloads.apache.org/incubator/devlake/KEYS , if not, please update https://downloads.apache.org/incubator/devlake/KEYS first.**
+**Please make sure your public key was included in the https://downloads.apache.org/incubator/devlake/KEYS , if not, please update this file first.**
## How to update KEYS
1. Clone the svn repository
```shell
@@ -17,22 +17,22 @@
svn commit -m "update KEYS"
svn cp https://dist.apache.org/repos/dist/dev/incubator/devlake/KEYS https://dist.apache.org/repos/dist/release/incubator/devlake/ -m "update KEYS"
```
-We will use `v0.12.0` as an example to demonstrate the release process.
+We will use `v0.14.0` as an example to demonstrate the release process.
## ASF Release Policy
-https://www.apache.org/legal/release-policy.html
-https://incubator.apache.org/guides/releasemanagement.html
+- https://www.apache.org/legal/release-policy.html
+- https://incubator.apache.org/guides/releasemanagement.html
## Tools:
-`gpg` creating and verifying the signature
-`shasum` creating and verifying the checksum
-`git` checkout and pack the codebase
-`svn` uploading the code to the Apache code hosting server
+- `gpg` creating and verifying the signature
+- `shasum` creating and verifying the checksum
+- `git` checkout and pack the codebase
+- `svn` uploading the code to the Apache code hosting server
## Prepare
- Check against the Incubator Release Checklist
-- Create folder `releases/lake-v0.12.0` and put the two files `docker-compose.yml` and `env.example` in there.
-- Update the file `.github/ISSUE_TEMPLATE/bug-report.yml` to include the version `v0.12.0`
+- Create folder `releases/lake-v0.14.0` and put the two files `docker-compose.yml` and `env.example` in there.
+- Update the file `.github/ISSUE_TEMPLATE/bug-report.yml` to include the version `v0.14.0`
## Pack
@@ -40,30 +40,30 @@ https://incubator.apache.org/guides/releasemanagement.html
```shell
git clone https://github.com/apache/incubator-devlake.git
cd incubator-devlake
- git checkout 25b718a5cc0c6a782c441965e3cbbce6877747d0
+ git checkout b268d53a48edb26d3c9b73b782798703f068f655
```
- Tag the commit and push to origin
```shell
- git tag v0.12.0-rc2
- git push origin v0.12.0-rc2
+ git tag v0.14.0-rc1
+ git push origin v0.14.0-rc1
```
- Pack the code
```shell
- git archive --format=tar.gz --output="<the-output-dir>/apache-devlake-0.12.0-incubating-src.tar.gz" --prefix="apache-devlake-0.12.0-incubating-src/" v0.12.0-rc2
+ git archive --format=tar.gz --output="<the-output-dir>/apache-devlake-0.14.0-incubating-src.tar.gz" --prefix="apache-devlake-0.14.0-incubating-src/" v0.14.0-rc1
```
- Before proceeding to the next step, please make sure your public key was included in the https://downloads.apache.org/incubator/devlake/KEYS
- Create signature and checksum
```shell
cd <the-output-dir>
- gpg -s --armor --output apache-devlake-0.12.0-incubating-src.tar.gz.asc --detach-sig apache-devlake-0.12.0-incubating-src.tar.gz
- shasum -a 512 apache-devlake-0.12.0-incubating-src.tar.gz > apache-devlake-0.12.0-incubating-src.tar.gz.sha512
+ gpg -s --armor --output apache-devlake-0.14.0-incubating-src.tar.gz.asc --detach-sig apache-devlake-0.14.0-incubating-src.tar.gz
+ shasum -a 512 apache-devlake-0.14.0-incubating-src.tar.gz > apache-devlake-0.14.0-incubating-src.tar.gz.sha512
```
- Verify signature and checksum
```shell
- gpg --verify apache-devlake-0.12.0-incubating-src.tar.gz.asc apache-devlake-0.12.0-incubating-src.tar.gz
- shasum -a 512 --check apache-devlake-0.12.0-incubating-src.tar.gz.sha512
+ gpg --verify apache-devlake-0.14.0-incubating-src.tar.gz.asc apache-devlake-0.14.0-incubating-src.tar.gz
+ shasum -a 512 --check apache-devlake-0.14.0-incubating-src.tar.gz.sha512
```
## Upload
- Clone the svn repository
@@ -73,43 +73,45 @@ https://incubator.apache.org/guides/releasemanagement.html
- Copy the files into the svn local directory
```shell
cd devlake
- mkdir -p 0.12.0-incubating-rc2
- cp <the-output-dir>/apache-devlake-0.12.0-incubating-src.tar.gz* 0.12.0-incubating-rc2/
- - Upload local files
- svn add 0.12.0-incubating-rc2
- svn commit -m "add 0.12.0-incubating-rc2"
+ mkdir -p 0.14.0-incubating-rc1
+ cp <the-output-dir>/apache-devlake-0.14.0-incubating-src.tar.gz* 0.14.0-incubating-rc1/
+ ```
+- Upload local files
+ ```shell
+ svn add 0.14.0-incubating-rc1
+ svn commit -m "add 0.14.0-incubating-rc1"
```
## Vote
1. Devlake community vote:
- Start the vote by sending an email to <de...@devlake.apache.org>
- [[VOTE] Release Apache DevLake (Incubating) v0.12.0-rc2](https://lists.apache.org/thread/yxy3kokhhhxlkxcr4op0pwslts7d8tcy)
- - Announce the vote result
- [[RESULT][VOTE] Release Apache DevLake (Incubating) v0.12.0-rc2](https://lists.apache.org/thread/qr3fj42tmryztt919jsy5q8hbpmcztky)
+ [[VOTE] Release Apache DevLake (Incubating) v0.14.0-rc1](https://lists.apache.org/thread/s6jj2tl5mlyb8jpdd88jmo5woydzhp54)
+ - Announce the vote result:
+ [[RESULT][VOTE] Release Apache DevLake (Incubating) v0.14.0-rc1](https://lists.apache.org/thread/mb5sxdopprqksf1ppfggkvkwxs6110zk)
2. Apache incubator community vote:
- Start the vote by sending an email to general@incubator.apache.org
- [[VOTE] Release Apache DevLake (Incubating) v0.12.0-rc2](https://lists.apache.org/thread/0bjroykzcyoj7pnjt7gjh1v3yofm901o)
- - Announce the vote result
- [[RESULT][VOTE] Release Apache DevLake (Incubating) v0.12.0-rc2](https://lists.apache.org/thread/y2pqg0c2hhgp0pcqolv19s27db190xsh)
+ [[VOTE] Release Apache DevLake (Incubating) v0.14.0-rc1](https://lists.apache.org/thread/lgfrsv0ymfk1c19ngnkkn46cspkf76lg)
+ - Announce the vote result:
+ [[RESULT][VOTE] Release Apache DevLake (Incubating) v0.14.0-rc1](https://lists.apache.org/thread/2xoqzymgvnrvrbn9dwsby39olotvt6oj)
## Release
### Apache
- Move the release to the ASF content distribution system
```shell
- svn mv https://dist.apache.org/repos/dist/dev/incubator/devlake/0.12.0-incubating-rc2 https://dist.apache.org/repos/dist/release/incubator/devlake/0.12.0-incubating -m "transfer packages for 0.12.0-incubating-rc2"
+ svn mv https://dist.apache.org/repos/dist/dev/incubator/devlake/0.14.0-incubating-rc1 https://dist.apache.org/repos/dist/release/incubator/devlake/0.14.0-incubating -m "transfer packages for 0.14.0-incubating-rc1"
```
-- Wait until the directory `https://downloads.apache.org/incubator/devlake/0.12.0-incubating/` was created
+- Wait until the directory `https://downloads.apache.org/incubator/devlake/0.14.0-incubating/` was created
- Remove the last release from `https://downloads.apache.org/` (according the Apache release policy, this link should be pointing to the current release)
```shell
svn rm https://dist.apache.org/repos/dist/release/incubator/devlake/0.11.0-incubating -m "remove 0.11.0-incubating"
```
- Announce release by sending an email to general@incubator.apache.org
- [[ANNOUNCE] Release Apache Devlake(incubating) 0.12.0-incubating](https://lists.apache.org/thread/7h6og1y6nhh4xr4r6rqbnswjoj3msxjk)
+ [[ANNOUNCE] Release Apache Devlake(incubating) 0.14.0-incubating](https://lists.apache.org/thread/401p8xm8tcp9tplh2sdht7dnrbs03rht)
### GitHub
-- Create tag v0.12.0 and push
+- Create tag v0.14.0 and push
```shell
- git checkout v0.12.0-rc2
- git tag v0.12.0
- git push origin v0.12.0
+ git checkout v0.14.0-rc1
+ git tag v0.14.0
+ git push origin v0.14.0
```
-- Create release v0.12.0 https://github.com/apache/incubator-devlake/releases/tag/v0.12.0
+- Open the URL `https://github.com/apache/incubator-devlake/releases/`, draft a new release, fill in the form and upload two files `docker-compose.yml` and `env.example`