pingsutw commented on a change in pull request #807: URL: https://github.com/apache/submarine/pull/807#discussion_r753636593
########## File path: website/docs/devDocs/HowToRelease.md ########## @@ -0,0 +1,475 @@ +--- +title: How to Release +--- + +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +> This article mainly introduces how the Release Manager releases a specific version of the project according to the Apache process. + +## 0. Preface + +Source Release is the focus of Apache’s attention and it is also a required content for release. Binary Release is optional, InLong can choose whether to release the binary package to the Apache warehouse or to the Maven central warehouse. + +Please refer to the following link to find more ASF release guidelines: + +[Apache Release Guide](https://incubator.apache.org/guides/releasemanagement.html) + +[Apache incubator](https://incubator.apache.org/) Review comment: We can remote it. ########## File path: website/docs/devDocs/HowToRelease.md ########## @@ -0,0 +1,475 @@ +--- +title: How to Release +--- + +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +> This article mainly introduces how the Release Manager releases a specific version of the project according to the Apache process. + +## 0. Preface + +Source Release is the focus of Apache’s attention and it is also a required content for release. Binary Release is optional, InLong can choose whether to release the binary package to the Apache warehouse or to the Maven central warehouse. + +Please refer to the following link to find more ASF release guidelines: + +[Apache Release Guide](https://incubator.apache.org/guides/releasemanagement.html) + +[Apache incubator](https://incubator.apache.org/) + +## 1. Add GPG KEY + +> Main references in this chapter:https://infra.apache.org/openpgp.html +> **This chapter is only needed for the first release manager of the project.** + +### 1.1 Install gpg + +Detailed installation documents can refer to [tutorial](https://www.gnupg.org/download/index.html), The environment configuration of Mac OS is as follows: + +```shell +$ brew install gpg +$ gpg --version #Check the version，should be 2.x +``` + +### 1.2 generate gpg Key + +#### Need to pay attention to the following points： + +- When entering the name, it is better to be consistent with the Full name registered in Apache +- The mailbox used should be apache mailbox +- It’s better to use pinyin or English for the name, otherwise there will be garbled characters + +#### Follow the hint，generate a key + +```shell +➜ ~ gpg --full-gen-key +gpg (GnuPG) 2.2.20; Copyright (C) 2020 Free Software Foundation, Inc. +This is free software: you are free to change and redistribute it. +There is NO WARRANTY, to the extent permitted by law. + +Please select what kind of key you want: + (1) RSA and RSA (default) + (2) DSA and Elgamal + (3) DSA (sign only) + (4) RSA (sign only) + (14) Existing key from card +Your selection? 1 # enter 1 here +RSA keys may be between 1024 and 4096 bits long. +What keysize do you want? (2048) 4096 # enter 4096 here +Requested keysize is 4096 bits +Please specify how long the key should be valid. + 0 = key does not expire + <n> = key expires in n days + <n>w = key expires in n weeks + <n>m = key expires in n months + <n>y = key expires in n years +Key is valid for? (0) 0 # enter 0 here +Key does not expire at all +Is this correct? (y/N) y # enter y here + +GnuPG needs to construct a user ID to identify your key. + +Real name: Guangxu Cheng # enter your name here +Email address: [email protected] # enter your mailbox here +Comment: # enter some comment here (Optional) +You selected this USER-ID: + "Guangxu Cheng <[email protected]>" + +Change (N)ame, (C)omment, (E)mail or (O)kay/(Q)uit? O #enter O here +We need to generate a lot of random bytes. It is a good idea to perform +some other action (type on the keyboard, move the mouse, utilize the +disks) during the prime generation; this gives the random number +generator a better chance to gain enough entropy. +We need to generate a lot of random bytes. It is a good idea to perform +some other action (type on the keyboard, move the mouse, utilize the +disks) during the prime generation; this gives the random number +generator a better chance to gain enough entropy. + +# A dialog box will pop up, asking you to enter the key for this gpg. +┌──────────────────────────────────────────────────────┐ +│ Please enter this passphrase │ +│ │ +│ Passphrase: _______________________________ │ +│ │ +│ <OK> <Cancel> │ +└──────────────────────────────────────────────────────┘ +# After entering the secret key, it will be created. And it will output the following information. +gpg: key 2DD587E7B10F3B1F marked as ultimately trusted +gpg: revocation certificate stored as '/Users/cheng/.gnupg/openpgp-revocs.d/41936314E25F402D5F7D73152DD587E7B10F3B1F.rev' +public and secret key created and signed. + +pub rsa4096 2020-05-19 [SC] + 41936314E25F402D5F7D73152DD587E7B10F3B1F +uid Guangxu Cheng <[email protected]> +sub rsa4096 2020-05-19 [E] +``` + +### 1.3 Upload the generated key to the public server + +```shell +➜ ~ gpg --list-keys +------------------------------- +pub rsa4096 2020-05-18 [SC] + 5931F8CFD04B37A325E4465D8C0D31C4149B3A87 +uid [ultimate] Guangxu Cheng <[email protected]> +sub rsa4096 2020-05-18 [E] + +# Send public key to keyserver via key id +$ gpg --keyserver pgpkeys.mit.edu --send-key <key id> +# Among them, pgpkeys.mit.edu is a randomly selected keyserver, and the keyserver list is: https://sks-keyservers.net/status/, which is automatically synchronized with each other, you can choose any one. +``` + +### 1.4 Check whether the key is created successfully + +Through the following URL, use the email to check whether the upload is successful or not. It will take about a minute to find out. When searching, check the show full-key hashes under advance on http://keys.gnupg.net. + +The query results are as follows: + +### 1.5 Add your gpg public key to the KEYS file + +> SVN is required for this step + +The svn library of the DEV branch is https://dist.apache.org/repos/dist/dev/incubator/inlong + +The SVN library of the Release branch is https://dist.apache.org/repos/dist/release/incubator/inlong Review comment: ```suggestion The svn library of the DEV branch is https://dist.apache.org/repos/dist/dev/submarine The SVN library of the Release branch is https://dist.apache.org/repos/dist/release/submarine ``` ```suggestion The svn library of the DEV branch is https://dist.apache.org/repos/dist/dev/incubator/inlong The SVN library of the Release branch is https://dist.apache.org/repos/dist/release/incubator/inlong ``` ########## File path: website/docs/devDocs/HowToRelease.md ########## @@ -0,0 +1,475 @@ +--- +title: How to Release +--- + +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +> This article mainly introduces how the Release Manager releases a specific version of the project according to the Apache process. + +## 0. Preface + +Source Release is the focus of Apache’s attention and it is also a required content for release. Binary Release is optional, InLong can choose whether to release the binary package to the Apache warehouse or to the Maven central warehouse. Review comment: ```suggestion Source Release is the focus of Apache’s attention and it is also a required content for release. Binary Release is optional, Submarine can choose whether to release the binary package to the Apache warehouse or to the Maven central warehouse. ``` ```suggestion Source Release is the focus of Apache’s attention and it is also a required content for release. Binary Release is optional, InLong can choose whether to release the binary package to the Apache warehouse or to the Maven central warehouse. ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
