[WIP] Add release guide for XTable #434
Conversation
| @@ -22,7 +22,7 @@ | |||
|
|
|||
| <groupId>org.apache.xtable</groupId> | |||
| <artifactId>xtable</artifactId> | |||
| <name>xtable</name> | |||
| <name>incubator-xtable</name> | |||
There was a problem hiding this comment.
Q: Is this required ? The guidelines say it is.
https://incubator.apache.org/guides/releasemanagement.html
The Incubator policies applies two additional constraints to podlings for their releases. They are repeated here for clarity only. - Release artifacts must include incubating in the final file name - Release artifacts must include one of two disclaimers
| @@ -0,0 +1,4 @@ | |||
| Apache XTable is an effort undergoing incubation at The Apache Software Foundation (ASF). | |||
There was a problem hiding this comment.
Added this based on guidelines mentioned in https://incubator.apache.org/guides/releasemanagement.html
| follow [the guide](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) to configure | ||
| command line access. | ||
|
|
||
| ## One-time Setup Instructions |
There was a problem hiding this comment.
Setting up GPG keys and other hardware for signing artifacts.
| limitations under the License. | ||
| --> | ||
|
|
||
| # Introduction |
There was a problem hiding this comment.
Intro about what the release process is going to be.
| Before your first release, you should perform one-time configuration steps. This will set up your security keys for | ||
| signing the release and access to various release repositories. | ||
|
|
||
| To prepare for each release, you should audit the project status in the JIRA issue tracker, and do the necessary |
There was a problem hiding this comment.
We don't have a JIRA setup, so should we use Github issues here ?
| @@ -0,0 +1,570 @@ | |||
| <!-- | |||
There was a problem hiding this comment.
I have re-used the release guide when hudi was in incubation stage
https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=135859726
Important Read
What is the purpose of the pull request
Add the release guide/process for Apache XTable, the guide has been added based on the guidelines provided by Apache.
https://infra.apache.org/release-publishing
https://www.apache.org/legal/release-policy.html
Special guidelines for incubating projects.
https://incubator.apache.org/guides/releasemanagement.html#best-practice
https://infra.apache.org/release-publishing.html#uploading
Brief change log
(for example:)
Verify this pull request
This pull request is a release guide without any test coverage, the guide will be run in a dry-run mode to ensure everything is working as expected before merging the change to main branch.