Skip to content

Instantly share code, notes, and snippets.

@edwardoliveira
Created October 5, 2016 16:59
Show Gist options
  • Select an option

  • Save edwardoliveira/d0072e94d397363a3c3afb6817f07d53 to your computer and use it in GitHub Desktop.

Select an option

Save edwardoliveira/d0072e94d397363a3c3afb6817f07d53 to your computer and use it in GitHub Desktop.
Hi,
The patch attached on ZOOKEEPER-2597 is a straightforward adaptation of Kafka's one. It takes care of merging Github PR into Apache git repo and a subsequent closing of the PR on the GH side, among other things (rewriting of commit messages, etc). The current status is: the script needs to be reviewed/validated by a committer. It has been some time since I uploaded the patch, so I gonna do another pass through it in the meantime.
There are some workflow issues beyond the scope of ZOOKEEPER-2597 that need to be sorted out (IMO):
1. The normal workflow is to open a JIRA ticket before doing any GH PR, that is, no JIRA-less PRs. The PR should have a title of the form "ZOOKEEPER-xxxx: Title". This will trigger the Apache JIRA-Github integration and it's opening show up in the JIRA ticket.
2. OTOH, not every Kafka PR needs a corresponding JIRA ticket. There are a class of PRs with "MINOR" title that represent trivial code changes and "HOT-FIX" title that fix urgent, but simple bugs. Both bypass the JIRA creation step, even tough they are still subject to review. It's worth adopting a similar approach for ZK project?
3. IIRC (didn't find any page to confirm), Cassandra project encourages, but not demands, that contributors also upload a patch file to JIRA even in the case of a GH PR (as to leave a audit trail, I guess). Or, at least, C* project leaves up to the contributors to either open a GH PR or upload the patch file to JIRA. In fact, Github allows the access to a raw patch or diff, it's just a matter of adding the ".patch" or ".diff" suffix to the end of the Pull Request URL.
+1 about having a 'paper trail' of review comments on JIRA and/or mailing list (I would prefer the mailing list tbh). But as Michael and Flavio pointed out, I never seen GH PR review **comments** being written back to JIRA, at least not in Kafka, Cassandra or Solr projects, that I have followed more closely.
Eddie
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment