WillemJiang closed pull request #59: Add the Release guide for ServiceComb
URL: https://github.com/apache/incubator-servicecomb-website/pull/59
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/_data/navigation.yml b/_data/navigation.yml
index f99055c..7ad9b42 100755
--- a/_data/navigation.yml
+++ b/_data/navigation.yml
@@ -127,6 +127,8 @@ t:
url: /developers/use-jira/
- title: "Set Up Write Access for Committer"
url: /developers/setup-committer-rights/
+ - title: "How to Release in Apache"
+ url: /developers/release-guide/
faqs:
- title: "FAQ"
@@ -286,6 +288,8 @@ t:
url: /cn/developers/use-jira/
- title: "设置代码仓库写权限"
url: /cn/developers/setup-committer-rights/
+ - title: "How to Release in Apache"
+ url: /cn/developers/release-guide/
faqs:
- title: "常见问题"
diff --git a/_developers/cn/release_guide.md b/_developers/cn/release_guide.md
new file mode 100644
index 0000000..443ab0a
--- /dev/null
+++ b/_developers/cn/release_guide.md
@@ -0,0 +1,233 @@
+---
+title: "Release guide for ServiceComb"
+lang: en
+ref: release_guide
+permalink: /cn/developers/release-guide/
+excerpt: "Release guide for doing the releases in Apache"
+last_modified_at: 2018-04-03T18:33:43+08:00
+author: Asif Siddiqui
+tags: [release]
+redirect_from:
+ - /theme-setup/
+---
+
+
+This Guide helps you to do the release in Apache for ServiceComb projects.
+
+## Pre-Requisite
+
+1. The CI for the project should be green.
+2. Should have the version number for the project.
+3. Should have Sign Key for signing the release, the keys should be published
to public key server.
+
+## Major Steps for doing Service-Center Release
+
+***Make and Verify the Release***
+
+1. Clone the service-center code.
+```
[email protected]:apache/incubator-servicecomb-service-center.git
+cd incubator-servicecomb-service-center
+gvt restore
+```
+
+2. Create a Tag from the master branch based on the version number which needs
to be released.
+
+3. Run RAT tool to ensure no license issues are there, follow the guide over
[here](https://github.com/apache/incubator-servicecomb-service-center/tree/master/docs/release)
+
+4. Run the make_release.sh to make the release for windows and linux following
the guide over
[here](https://github.com/apache/incubator-servicecomb-service-center/tree/master/scripts/release).
+
+5. Last Step will make the releases in root folder.
+
+6. Run the releases of frontend and service-center in both linux and windows.
+
+7. Run the [integration
test](https://github.com/apache/incubator-servicecomb-service-center/tree/master/integration)
on the release.
+
+8. If all the test passes then send the release candidate to peers to test in
different machines.
+
+9. Push the tag to master.
+
+***Sign the Release***
+
+10. Once the tag is pushed then using the tag download the source code from
git [tag](https://github.com/apache/incubator-servicecomb-service-center/tags).
+
+11. Sign the 3 releases(linux, windows, src) and checksum.
+
+12. Upload the release to dev/incubator/servicecomb Apache Svn.
+
+13. Download all the releases from SVN and verify the signature and checksum.
+
+***PPMC Approval***
+
+14. Send the voting mail in ***[email protected]*** for PPMC approval.
+
+15. Wait for 72 hours or unless you get 3 +1 binding vote with no -1 vote. If
you get even one -1 binding vote then fix the issue and start again from
***Step 1***.
+
+16. Publish the result of the vote in [email protected].
+
+***IPMC approval***
+
+17. Send the voting mail in ***[email protected]*** for IPMC
approval.
+
+18. Wait for 72 hours or unless you get 3 +1 binding vote with no -1 vote.If
you get even one -1 binding vote then fix the issue and start again from
***Step 1***
+
+19. Publish the result of the vote in [email protected].
+
+***Announcements***
+
+20. Upload the releases to release/incubator/servicecomb Apache Svn.
+
+21. Wait for 24 hours to replicate the release in all the mirrors.
+
+22. Upload the release page of ServiceComb Website.
+
+23. Send the announcement mails to [email protected],
[email protected], [email protected]
+
+
+
+
+## Major Steps for doing Java-Chassis Release
+
+***Make and Verify the Release***
+
+1. Clone the java-chassis code.
+```
+git clone [email protected]:apache/incubator-servicecomb-java-chassis.git
+```
+
+2. Cut the release using per command to replace all the versions in pom.xml
files
+
+3. Create a Tag from the master branch using the version number.
+
+4. Clear all the redundant servicecomb releases in repository.apache.org
+
+5. Add the keys in a reference folder.
+
+6. Update the key path and passphrase in .travis.settings file.
+
+7. Update the apache account username and password in the travis file.
+
+8. Run the maven deploy command.
+```
+mvn deploy -DskipTests -Prelease -Pdistribution -Ppassphrase --settings
.travis.settings.xml
+```
+
+9. Once every thing is uploaded then use the staging repo to verify the build
using Company workshop.
+
+10. Share the staging repo with peers to verify on different OS and machines
using the demo.
+
+11. If everything is fine then push the tag to master.
+
+12. Close the staging repo is apache repositories
+
+***Sign the Releases***
+
+13. Download the source code and distribution from the staging repo.
+
+14. Sign the 2 releases(distribution, src) and checksum.
+
+15. Upload the release to dev/incubator/servicecomb Apache Svn.
+
+16. Download all the releases from SVN and verify the signature and checksum.
+
+***PPMC approval***
+
+17. Send the voting mail in [email protected] for PPMC approval.
+
+18. Wait for 72 hours or unless you get 3 +1 binding vote with no -1 vote. If
you get even one -1 binding vote then fix the issue and start again from Step 1.
+
+19. Publish the result of the vote in [email protected].
+
+***IPMC approval***
+
+20. Send the voting mail in [email protected]
+
+21. Wait for 72 hours or unless you get 3 +1 binding vote with no -1 vote. If
you get even one -1 binding vote then fix the issue and start again from Step
1.
+
+22. Publish the result of the vote in [email protected].
+
+***Announcements***
+
+23. Upload the releases to release/incubator/servicecomb Apache Svn.
+
+24. Wait for 24 hours to replicate the release in all the mirrors.
+
+25. Upload the release page of ServiceComb Website.
+
+26. Send the announcement mails to [email protected],
[email protected], [email protected]
+
+
+
+
+## Major Steps for doing Saga Release
+
+***Make and Verify the Release***
+1. Clone the saga code.
+```
[email protected]:apache/incubator-servicecomb-saga.git
+```
+
+2. Cut the release using per command to replace all the versions in pom.xml
files
+
+3. Create a Tag from the master branch using the version number.
+
+4. Clear all the redundant servicecomb releases in repository.apache.org
+
+5. Add the keys in a reference folder.
+
+6. Update the key path and passphrase in .travis.settings file.
+
+7. Update the apache account username and password in the travis file.
+
+8. Run the maven deploy command.
+```
+mvn deploy -DskipTests --settings .travis.settings.xml -Ppassphrase -Prelease
+```
+
+9. Once every thing is uploaded then use the staging repo to verify the build
using Company workshop.
+
+10. Share the staging repo with peers to verify on different OS and machines
using the demo.
+
+11. If everything is fine then push the tag to master.
+
+12. Close the staging repo is apache repositories.
+
+***Sign the Releases***
+
+13. Download the source code and distribution from the staging repo.
+
+14. Sign the 2 releases(distribution, src) and checksum.
+
+15. Upload the release to dev/incubator/servicecomb Apache Svn.
+
+16. Download all the releases from SVN and verify the signature and checksum.
+
+***PPMC approval***
+
+17. Send the voting mail in [email protected].
+
+18. Wait for 72 hours or unless you get 3 +1 binding vote with no -1 vote. If
you get even one -1 binding vote then fix the issue and start again from Step 1.
+
+19. Publish the result of the vote in [email protected].
+
+***IPMC approval***
+
+20. Send the voting mail in [email protected]
+
+21. Wait for 72 hours or unless you get 3 +1 binding vote with no -1 vote. If
you get even one -1 binding vote then fix the issue and start again from Step 1.
+
+22. Publish the result of the vote in [email protected].
+
+***Announcements***
+
+23. Upload the releases to release/incubator/servicecomb Apache Svn.
+
+24. Wait for 24 hours to replicate the release in all the mirrors.
+
+25. Upload the release page of ServiceComb Website.
+
+26. Send the announcement mails to [email protected],
[email protected], [email protected]
+
+
+**NOTE**
+The whole process generally takes 2 weeks to complete assuming you don't get
any -1 from PPMC and IMPC, so please plan the release activity before hand.
diff --git a/_developers/release_guide.md b/_developers/release_guide.md
new file mode 100644
index 0000000..f6e0e50
--- /dev/null
+++ b/_developers/release_guide.md
@@ -0,0 +1,233 @@
+---
+title: "Release guide for ServiceComb"
+lang: en
+ref: release_guide
+permalink: /developers/release-guide/
+excerpt: "Release guide for doing the releases in Apache"
+last_modified_at: 2018-04-03T18:33:43+08:00
+author: Asif Siddiqui
+tags: [release]
+redirect_from:
+ - /theme-setup/
+---
+
+
+This Guide helps you to do the release in Apache for ServiceComb projects.
+
+## Pre-Requisite
+
+1. The CI for the project should be green.
+2. Should have the version number for the project.
+3. Should have Sign Key for signing the release, the keys should be published
to public key server.
+
+## Major Steps for doing Service-Center Release
+
+***Make and Verify the Release***
+
+1. Clone the service-center code.
+```
[email protected]:apache/incubator-servicecomb-service-center.git
+cd incubator-servicecomb-service-center
+gvt restore
+```
+
+2. Create a Tag from the master branch based on the version number which needs
to be released.
+
+3. Run RAT tool to ensure no license issues are there, follow the guide over
[here](https://github.com/apache/incubator-servicecomb-service-center/tree/master/docs/release)
+
+4. Run the make_release.sh to make the release for windows and linux following
the guide over
[here](https://github.com/apache/incubator-servicecomb-service-center/tree/master/scripts/release).
+
+5. Last Step will make the releases in root folder.
+
+6. Run the releases of frontend and service-center in both linux and windows.
+
+7. Run the [integration
test](https://github.com/apache/incubator-servicecomb-service-center/tree/master/integration)
on the release.
+
+8. If all the test passes then send the release candidate to peers to test in
different machines.
+
+9. Push the tag to master.
+
+***Sign the Release***
+
+10. Once the tag is pushed then using the tag download the source code from
git [tag](https://github.com/apache/incubator-servicecomb-service-center/tags).
+
+11. Sign the 3 releases(linux, windows, src) and checksum.
+
+12. Upload the release to dev/incubator/servicecomb Apache Svn.
+
+13. Download all the releases from SVN and verify the signature and checksum.
+
+***PPMC Approval***
+
+14. Send the voting mail in ***[email protected]*** for PPMC approval.
+
+15. Wait for 72 hours or unless you get 3 +1 binding vote with no -1 vote. If
you get even one -1 binding vote then fix the issue and start again from
***Step 1***.
+
+16. Publish the result of the vote in [email protected].
+
+***IPMC approval***
+
+17. Send the voting mail in ***[email protected]*** for IPMC
approval.
+
+18. Wait for 72 hours or unless you get 3 +1 binding vote with no -1 vote.If
you get even one -1 binding vote then fix the issue and start again from
***Step 1***
+
+19. Publish the result of the vote in [email protected].
+
+***Announcements***
+
+20. Upload the releases to release/incubator/servicecomb Apache Svn.
+
+21. Wait for 24 hours to replicate the release in all the mirrors.
+
+22. Upload the release page of ServiceComb Website.
+
+23. Send the announcement mails to [email protected],
[email protected], [email protected]
+
+
+
+
+## Major Steps for doing Java-Chassis Release
+
+***Make and Verify the Release***
+
+1. Clone the java-chassis code.
+```
+git clone [email protected]:apache/incubator-servicecomb-java-chassis.git
+```
+
+2. Cut the release using per command to replace all the versions in pom.xml
files
+
+3. Create a Tag from the master branch using the version number.
+
+4. Clear all the redundant servicecomb releases in repository.apache.org
+
+5. Add the keys in a reference folder.
+
+6. Update the key path and passphrase in .travis.settings file.
+
+7. Update the apache account username and password in the travis file.
+
+8. Run the maven deploy command.
+```
+mvn deploy -DskipTests -Prelease -Pdistribution -Ppassphrase --settings
.travis.settings.xml
+```
+
+9. Once every thing is uploaded then use the staging repo to verify the build
using Company workshop.
+
+10. Share the staging repo with peers to verify on different OS and machines
using the demo.
+
+11. If everything is fine then push the tag to master.
+
+12. Close the staging repo is apache repositories
+
+***Sign the Releases***
+
+13. Download the source code and distribution from the staging repo.
+
+14. Sign the 2 releases(distribution, src) and checksum.
+
+15. Upload the release to dev/incubator/servicecomb Apache Svn.
+
+16. Download all the releases from SVN and verify the signature and checksum.
+
+***PPMC approval***
+
+17. Send the voting mail in [email protected] for PPMC approval.
+
+18. Wait for 72 hours or unless you get 3 +1 binding vote with no -1 vote. If
you get even one -1 binding vote then fix the issue and start again from Step 1.
+
+19. Publish the result of the vote in [email protected].
+
+***IPMC approval***
+
+20. Send the voting mail in [email protected]
+
+21. Wait for 72 hours or unless you get 3 +1 binding vote with no -1 vote. If
you get even one -1 binding vote then fix the issue and start again from Step
1.
+
+22. Publish the result of the vote in [email protected].
+
+***Announcements***
+
+23. Upload the releases to release/incubator/servicecomb Apache Svn.
+
+24. Wait for 24 hours to replicate the release in all the mirrors.
+
+25. Upload the release page of ServiceComb Website.
+
+26. Send the announcement mails to [email protected],
[email protected], [email protected]
+
+
+
+
+## Major Steps for doing Saga Release
+
+***Make and Verify the Release***
+1. Clone the saga code.
+```
[email protected]:apache/incubator-servicecomb-saga.git
+```
+
+2. Cut the release using per command to replace all the versions in pom.xml
files
+
+3. Create a Tag from the master branch using the version number.
+
+4. Clear all the redundant servicecomb releases in repository.apache.org
+
+5. Add the keys in a reference folder.
+
+6. Update the key path and passphrase in .travis.settings file.
+
+7. Update the apache account username and password in the travis file.
+
+8. Run the maven deploy command.
+```
+mvn deploy -DskipTests --settings .travis.settings.xml -Ppassphrase -Prelease
+```
+
+9. Once every thing is uploaded then use the staging repo to verify the build
using Company workshop.
+
+10. Share the staging repo with peers to verify on different OS and machines
using the demo.
+
+11. If everything is fine then push the tag to master.
+
+12. Close the staging repo is apache repositories.
+
+***Sign the Releases***
+
+13. Download the source code and distribution from the staging repo.
+
+14. Sign the 2 releases(distribution, src) and checksum.
+
+15. Upload the release to dev/incubator/servicecomb Apache Svn.
+
+16. Download all the releases from SVN and verify the signature and checksum.
+
+***PPMC approval***
+
+17. Send the voting mail in [email protected].
+
+18. Wait for 72 hours or unless you get 3 +1 binding vote with no -1 vote. If
you get even one -1 binding vote then fix the issue and start again from Step 1.
+
+19. Publish the result of the vote in [email protected].
+
+***IPMC approval***
+
+20. Send the voting mail in [email protected]
+
+21. Wait for 72 hours or unless you get 3 +1 binding vote with no -1 vote. If
you get even one -1 binding vote then fix the issue and start again from Step 1.
+
+22. Publish the result of the vote in [email protected].
+
+***Announcements***
+
+23. Upload the releases to release/incubator/servicecomb Apache Svn.
+
+24. Wait for 24 hours to replicate the release in all the mirrors.
+
+25. Upload the release page of ServiceComb Website.
+
+26. Send the announcement mails to [email protected],
[email protected], [email protected]
+
+
+**NOTE**
+The whole process generally takes 2 weeks to complete assuming you don't get
any -1 from PPMC and IMPC, so please plan the release activity before hand.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
