You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@calcite.apache.org by GitBox <gi...@apache.org> on 2020/10/23 09:12:43 UTC

[GitHub] [calcite] rubenada opened a new pull request #2229: Improvements in site how-to

rubenada opened a new pull request #2229:
URL: https://github.com/apache/calcite/pull/2229


   Some changes on how-to release managing sections, after my experience as release manager.


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [calcite] rubenada commented on a change in pull request #2229: Update release instructions

Posted by GitBox <gi...@apache.org>.
rubenada commented on a change in pull request #2229:
URL: https://github.com/apache/calcite/pull/2229#discussion_r519808470



##########
File path: site/_docs/howto.md
##########
@@ -684,8 +688,13 @@ Note: release artifacts (dist.apache.org and repository.apache.org) are managed
 
 Before you start:
 
+* Send an email to [dev@calcite.apache.org](mailto:dev@calcite.apache.org) notifying that RC build process
+  is starting and therefore `master` branch is in code freeze until further notice.
 * Set up signing keys as described above.
 * Make sure you are using JDK 8 (not 9 or 10).
+* Make sure `master` branch and `site` branch are in sync, i.e. there is no commit on `site` that has not
+  been applied also to `master`. You can check by doing `git checkout site; git rebase -i master`.
+  If they are not in sync, cherry-pick the missing commit(s) into `master`.

Review comment:
       OK, changed.




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [calcite] vlsi commented on a change in pull request #2229: Update release instructions

Posted by GitBox <gi...@apache.org>.
vlsi commented on a change in pull request #2229:
URL: https://github.com/apache/calcite/pull/2229#discussion_r516059392



##########
File path: site/_docs/howto.md
##########
@@ -684,8 +688,13 @@ Note: release artifacts (dist.apache.org and repository.apache.org) are managed
 
 Before you start:
 
+* Send an email to [dev@calcite.apache.org](mailto:dev@calcite.apache.org) notifying that RC build process
+  is starting and therefore `master` branch is in code freeze until further notice.
 * Set up signing keys as described above.
 * Make sure you are using JDK 8 (not 9 or 10).
+* Make sure `master` branch and `site` branch are in sync, i.e. there is no commit on `site` that has not
+  been applied also to `master`. You can check by doing `git checkout site; git rebase -i master`.
+  If they are not in sync, cherry-pick the missing commit(s) into `master`.

Review comment:
       > If they are not in sync, cherry-pick the missing commit(s) into `master`.
   
   This is exactly what `git checkout site; git rebase -i master` does, so it might be misleading to recommend `rebase -i master` and then suggest to cherry-pick.

##########
File path: site/_docs/howto.md
##########
@@ -684,8 +688,13 @@ Note: release artifacts (dist.apache.org and repository.apache.org) are managed
 
 Before you start:
 
+* Send an email to [dev@calcite.apache.org](mailto:dev@calcite.apache.org) notifying that RC build process
+  is starting and therefore `master` branch is in code freeze until further notice.
 * Set up signing keys as described above.
 * Make sure you are using JDK 8 (not 9 or 10).
+* Make sure `master` branch and `site` branch are in sync, i.e. there is no commit on `site` that has not
+  been applied also to `master`. You can check by doing `git checkout site; git rebase -i master`.
+  If they are not in sync, cherry-pick the missing commit(s) into `master`.

Review comment:
       It would be nice to publish documentation for all the versions (all released and the current development), then we could drop `site` branch altogether :)

##########
File path: site/_docs/howto.md
##########
@@ -684,8 +688,13 @@ Note: release artifacts (dist.apache.org and repository.apache.org) are managed
 
 Before you start:
 
+* Send an email to [dev@calcite.apache.org](mailto:dev@calcite.apache.org) notifying that RC build process
+  is starting and therefore `master` branch is in code freeze until further notice.
 * Set up signing keys as described above.
 * Make sure you are using JDK 8 (not 9 or 10).
+* Make sure `master` branch and `site` branch are in sync, i.e. there is no commit on `site` that has not
+  been applied also to `master`. You can check by doing `git checkout site; git rebase -i master`.
+  If they are not in sync, cherry-pick the missing commit(s) into `master`.

Review comment:
       You are right. Something like `git checkout master; git reset --hard site` is required to update master to the "new site".

##########
File path: site/_docs/howto.md
##########
@@ -684,8 +688,13 @@ Note: release artifacts (dist.apache.org and repository.apache.org) are managed
 
 Before you start:
 
+* Send an email to [dev@calcite.apache.org](mailto:dev@calcite.apache.org) notifying that RC build process
+  is starting and therefore `master` branch is in code freeze until further notice.
 * Set up signing keys as described above.
 * Make sure you are using JDK 8 (not 9 or 10).
+* Make sure `master` branch and `site` branch are in sync, i.e. there is no commit on `site` that has not
+  been applied also to `master`. You can check by doing `git checkout site; git rebase -i master`.
+  If they are not in sync, cherry-pick the missing commit(s) into `master`.

Review comment:
       AFAIK `git switch site; git rebase --empty=drop master; git switch master; git reset --hard site` should so the trick.
   
   Frankly speaking, the key problem for me was to understand the intention behind `site` vs `master` branch. The actual commands are not that hard once you understand why `site` and `master` can differ.




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [calcite] danny0405 commented on a change in pull request #2229: Improvements in site how-to

Posted by GitBox <gi...@apache.org>.
danny0405 commented on a change in pull request #2229:
URL: https://github.com/apache/calcite/pull/2229#discussion_r511774702



##########
File path: site/_docs/howto.md
##########
@@ -684,8 +684,14 @@ Note: release artifacts (dist.apache.org and repository.apache.org) are managed
 
 Before you start:
 
+* Send an email to [dev@calcite.apache.org](mailto:dev@calcite.apache.org) notifying that RC build process
+  is starting and therefore `master` branch is in code freeze until further notice.
 * Set up signing keys as described above.
+* Upload your key to [https://keyserver.ubuntu.com](https://keyserver.ubuntu.com) and/or
+  [http://pool.sks-keyservers.net:11371](http://pool.sks-keyservers.net:11371) (keyservers used by Nexus).

Review comment:
       Also notice that upload the key is only needed for the first time release manager.




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [calcite] rubenada commented on a change in pull request #2229: Update release instructions

Posted by GitBox <gi...@apache.org>.
rubenada commented on a change in pull request #2229:
URL: https://github.com/apache/calcite/pull/2229#discussion_r516067535



##########
File path: site/_docs/howto.md
##########
@@ -684,8 +688,13 @@ Note: release artifacts (dist.apache.org and repository.apache.org) are managed
 
 Before you start:
 
+* Send an email to [dev@calcite.apache.org](mailto:dev@calcite.apache.org) notifying that RC build process
+  is starting and therefore `master` branch is in code freeze until further notice.
 * Set up signing keys as described above.
 * Make sure you are using JDK 8 (not 9 or 10).
+* Make sure `master` branch and `site` branch are in sync, i.e. there is no commit on `site` that has not
+  been applied also to `master`. You can check by doing `git checkout site; git rebase -i master`.
+  If they are not in sync, cherry-pick the missing commit(s) into `master`.

Review comment:
       You're right, I will re-phrase it.

##########
File path: site/_docs/howto.md
##########
@@ -684,8 +688,13 @@ Note: release artifacts (dist.apache.org and repository.apache.org) are managed
 
 Before you start:
 
+* Send an email to [dev@calcite.apache.org](mailto:dev@calcite.apache.org) notifying that RC build process
+  is starting and therefore `master` branch is in code freeze until further notice.
 * Set up signing keys as described above.
 * Make sure you are using JDK 8 (not 9 or 10).
+* Make sure `master` branch and `site` branch are in sync, i.e. there is no commit on `site` that has not
+  been applied also to `master`. You can check by doing `git checkout site; git rebase -i master`.
+  If they are not in sync, cherry-pick the missing commit(s) into `master`.

Review comment:
       Agree, there was a discussion about that some time ago [1], but I think no action has been taken in that direction.
   
   [1] https://lists.apache.org/thread.html/0d9829f7e32f51bc03fc350fe7c782c03dedb2ecca90e983917abf53%40%3Cdev.calcite.apache.org%3E

##########
File path: site/_docs/howto.md
##########
@@ -684,8 +688,13 @@ Note: release artifacts (dist.apache.org and repository.apache.org) are managed
 
 Before you start:
 
+* Send an email to [dev@calcite.apache.org](mailto:dev@calcite.apache.org) notifying that RC build process
+  is starting and therefore `master` branch is in code freeze until further notice.
 * Set up signing keys as described above.
 * Make sure you are using JDK 8 (not 9 or 10).
+* Make sure `master` branch and `site` branch are in sync, i.e. there is no commit on `site` that has not
+  been applied also to `master`. You can check by doing `git checkout site; git rebase -i master`.
+  If they are not in sync, cherry-pick the missing commit(s) into `master`.

Review comment:
       @vlsi correct me if I'm wrong. The goal of this point is to ensure that "there is no commit on `site` that has not been applied also to `master`", otherwise we should apply these commits (onto `master`).
   Doing a `git checkout site; git rebase -i master` will point the commits on `site` that are not in `master` (if any); but will not modify the `master` branch. That is why the `cherry-pick` tried to express; or am I wrong?

##########
File path: site/_docs/howto.md
##########
@@ -684,8 +688,13 @@ Note: release artifacts (dist.apache.org and repository.apache.org) are managed
 
 Before you start:
 
+* Send an email to [dev@calcite.apache.org](mailto:dev@calcite.apache.org) notifying that RC build process
+  is starting and therefore `master` branch is in code freeze until further notice.
 * Set up signing keys as described above.
 * Make sure you are using JDK 8 (not 9 or 10).
+* Make sure `master` branch and `site` branch are in sync, i.e. there is no commit on `site` that has not
+  been applied also to `master`. You can check by doing `git checkout site; git rebase -i master`.
+  If they are not in sync, cherry-pick the missing commit(s) into `master`.

Review comment:
       We need to be careful because there can be site-related commits in `master` that are not in `site`, this is "allowed" and we must not lose them.
   Having commits in `site` that are not in `master` should not happen, but it can be possible if someone makes a (small) mistake.
   All in all, I think the current phrase (`git checkout site; git rebase -i master` + `cherry-pick` any missing commits into master) might be the safest approach to achieve this without losing any master commit. wdyt?




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [calcite] vlsi commented on a change in pull request #2229: Update release instructions

Posted by GitBox <gi...@apache.org>.
vlsi commented on a change in pull request #2229:
URL: https://github.com/apache/calcite/pull/2229#discussion_r519776304



##########
File path: site/_docs/howto.md
##########
@@ -684,8 +688,13 @@ Note: release artifacts (dist.apache.org and repository.apache.org) are managed
 
 Before you start:
 
+* Send an email to [dev@calcite.apache.org](mailto:dev@calcite.apache.org) notifying that RC build process
+  is starting and therefore `master` branch is in code freeze until further notice.
 * Set up signing keys as described above.
 * Make sure you are using JDK 8 (not 9 or 10).
+* Make sure `master` branch and `site` branch are in sync, i.e. there is no commit on `site` that has not
+  been applied also to `master`. You can check by doing `git checkout site; git rebase -i master`.
+  If they are not in sync, cherry-pick the missing commit(s) into `master`.

Review comment:
       Oh, I guess it would be better to use `git switch site && git rebase --empty=drop master && git switch master && git reset --hard site` to avoid accidental `git reset --hard` in case one of the previous commands fail :)




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [calcite] rubenada commented on a change in pull request #2229: Update release instructions

Posted by GitBox <gi...@apache.org>.
rubenada commented on a change in pull request #2229:
URL: https://github.com/apache/calcite/pull/2229#discussion_r519757384



##########
File path: site/_docs/howto.md
##########
@@ -684,8 +688,13 @@ Note: release artifacts (dist.apache.org and repository.apache.org) are managed
 
 Before you start:
 
+* Send an email to [dev@calcite.apache.org](mailto:dev@calcite.apache.org) notifying that RC build process
+  is starting and therefore `master` branch is in code freeze until further notice.
 * Set up signing keys as described above.
 * Make sure you are using JDK 8 (not 9 or 10).
+* Make sure `master` branch and `site` branch are in sync, i.e. there is no commit on `site` that has not
+  been applied also to `master`. You can check by doing `git checkout site; git rebase -i master`.
+  If they are not in sync, cherry-pick the missing commit(s) into `master`.

Review comment:
       Ok, rephrased. I'll trust you on this git magic :)
   




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [calcite] rubenada commented on a change in pull request #2229: Update release instructions

Posted by GitBox <gi...@apache.org>.
rubenada commented on a change in pull request #2229:
URL: https://github.com/apache/calcite/pull/2229#discussion_r519757991



##########
File path: site/_docs/howto.md
##########
@@ -684,8 +684,14 @@ Note: release artifacts (dist.apache.org and repository.apache.org) are managed
 
 Before you start:
 
+* Send an email to [dev@calcite.apache.org](mailto:dev@calcite.apache.org) notifying that RC build process
+  is starting and therefore `master` branch is in code freeze until further notice.
 * Set up signing keys as described above.
+* Upload your key to [https://keyserver.ubuntu.com](https://keyserver.ubuntu.com) and/or
+  [http://pool.sks-keyservers.net:11371](http://pool.sks-keyservers.net:11371) (keyservers used by Nexus).

Review comment:
       Changed.




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [calcite] rubenada commented on pull request #2229: Improvements in site how-to

Posted by GitBox <gi...@apache.org>.
rubenada commented on pull request #2229:
URL: https://github.com/apache/calcite/pull/2229#issuecomment-716423038


   Thanks for your feedback @julianhyde , @danny0405 . I have reviewed my changes.


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [calcite] julianhyde commented on a change in pull request #2229: Improvements in site how-to

Posted by GitBox <gi...@apache.org>.
julianhyde commented on a change in pull request #2229:
URL: https://github.com/apache/calcite/pull/2229#discussion_r511029424



##########
File path: site/_docs/howto.md
##########
@@ -990,6 +992,12 @@ address. You can use
 [the 1.20.0 announcement](https://mail-archives.apache.org/mod_mbox/www-announce/201906.mbox/%3CCA%2BEpF8tcJcZ41rVuwJODJmyRy-qAxZUQm9OxKsoDi07c2SKs_A%40mail.gmail.com%3E)
 as a template. Be sure to include a brief description of the project.
 
+Finally, increase the `calcite.version` value in `/gradle.properties` and commit & push
+the change with the message "Prepare for next development iteration".
+
+Send an email to [dev@calcite.apache.org](mailto:dev@calcite.apache.org) notifying
+that `master` code freeze is over and commits can resume.

Review comment:
       Change to 'Re-open the master branch. Send an email ...'. Documentation is clearer if you lead with the purpose/high-level action.

##########
File path: site/_docs/howto.md
##########
@@ -684,8 +684,14 @@ Note: release artifacts (dist.apache.org and repository.apache.org) are managed
 
 Before you start:
 
+* Send an email to [dev@calcite.apache.org](mailto:dev@calcite.apache.org) notifying that RC build process
+  is starting and therefore `master` branch is in code freeze until further notice.
 * Set up signing keys as described above.
+* Upload your key to [https://keyserver.ubuntu.com](https://keyserver.ubuntu.com) and/or
+  [http://pool.sks-keyservers.net:11371](http://pool.sks-keyservers.net:11371) (keyservers used by Nexus).

Review comment:
       Move the 'upload your key' to the 'set up signing keys' section. Maybe add a troubleshooting point 'If xxx happens make sure that you uploaded your key to ubuntu'.

##########
File path: site/_docs/howto.md
##########
@@ -990,6 +992,12 @@ address. You can use
 [the 1.20.0 announcement](https://mail-archives.apache.org/mod_mbox/www-announce/201906.mbox/%3CCA%2BEpF8tcJcZ41rVuwJODJmyRy-qAxZUQm9OxKsoDi07c2SKs_A%40mail.gmail.com%3E)
 as a template. Be sure to include a brief description of the project.
 
+Finally, increase the `calcite.version` value in `/gradle.properties` and commit & push

Review comment:
       Give an example commit that people can cherry-pick.

##########
File path: site/_docs/howto.md
##########
@@ -684,8 +684,14 @@ Note: release artifacts (dist.apache.org and repository.apache.org) are managed
 
 Before you start:
 
+* Send an email to [dev@calcite.apache.org](mailto:dev@calcite.apache.org) notifying that RC build process
+  is starting and therefore `master` branch is in code freeze until further notice.
 * Set up signing keys as described above.
+* Upload your key to [https://keyserver.ubuntu.com](https://keyserver.ubuntu.com) and/or
+  [http://pool.sks-keyservers.net:11371](http://pool.sks-keyservers.net:11371) (keyservers used by Nexus).
 * Make sure you are using JDK 8 (not 9 or 10).
+* Make sure `master` branch and `site` branch are in sync, i.e. there is no commit on `site` that has not
+  been applied also to `master`. If this the case, cherry-pick the missing commit(s) into `master`.

Review comment:
       You can check by doing something like 'git checkout site; git rebase -i master'.

##########
File path: site/_docs/howto.md
##########
@@ -990,6 +992,12 @@ address. You can use
 [the 1.20.0 announcement](https://mail-archives.apache.org/mod_mbox/www-announce/201906.mbox/%3CCA%2BEpF8tcJcZ41rVuwJODJmyRy-qAxZUQm9OxKsoDi07c2SKs_A%40mail.gmail.com%3E)
 as a template. Be sure to include a brief description of the project.
 
+Finally, increase the `calcite.version` value in `/gradle.properties` and commit & push

Review comment:
       Remove 'finally'.




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [calcite] rubenada commented on a change in pull request #2229: Update release instructions

Posted by GitBox <gi...@apache.org>.
rubenada commented on a change in pull request #2229:
URL: https://github.com/apache/calcite/pull/2229#discussion_r519756550



##########
File path: site/_docs/howto.md
##########
@@ -990,6 +992,12 @@ address. You can use
 [the 1.20.0 announcement](https://mail-archives.apache.org/mod_mbox/www-announce/201906.mbox/%3CCA%2BEpF8tcJcZ41rVuwJODJmyRy-qAxZUQm9OxKsoDi07c2SKs_A%40mail.gmail.com%3E)
 as a template. Be sure to include a brief description of the project.
 
+Finally, increase the `calcite.version` value in `/gradle.properties` and commit & push
+the change with the message "Prepare for next development iteration".
+
+Send an email to [dev@calcite.apache.org](mailto:dev@calcite.apache.org) notifying
+that `master` code freeze is over and commits can resume.

Review comment:
       Changed




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [calcite] rubenada commented on a change in pull request #2229: Update release instructions

Posted by GitBox <gi...@apache.org>.
rubenada commented on a change in pull request #2229:
URL: https://github.com/apache/calcite/pull/2229#discussion_r519757839



##########
File path: site/_docs/howto.md
##########
@@ -990,6 +992,12 @@ address. You can use
 [the 1.20.0 announcement](https://mail-archives.apache.org/mod_mbox/www-announce/201906.mbox/%3CCA%2BEpF8tcJcZ41rVuwJODJmyRy-qAxZUQm9OxKsoDi07c2SKs_A%40mail.gmail.com%3E)
 as a template. Be sure to include a brief description of the project.
 
+Finally, increase the `calcite.version` value in `/gradle.properties` and commit & push

Review comment:
       Modified.




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [calcite] rubenada commented on pull request #2229: Update release instructions

Posted by GitBox <gi...@apache.org>.
rubenada commented on pull request #2229:
URL: https://github.com/apache/calcite/pull/2229#issuecomment-720524457


   @julianhyde @danny0405 gentle reminder. Please take a look at the PR when you have some time.


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [calcite] rubenada commented on pull request #2229: Update release instructions

Posted by GitBox <gi...@apache.org>.
rubenada commented on pull request #2229:
URL: https://github.com/apache/calcite/pull/2229#issuecomment-728809157


   @julianhyde since you requested changes, are you ok with the current status of the PR?


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [calcite] rubenada merged pull request #2229: Update release instructions

Posted by GitBox <gi...@apache.org>.
rubenada merged pull request #2229:
URL: https://github.com/apache/calcite/pull/2229


   


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org