/bigdata-community

Bigtop Patch Process

Kevin W Monroe edited this page Oct 7, 2016 · 15 revisions

For consistency, we should use the following process for managing our proposed contributions to the upstream Apache Bigtop project:

  1. Create a Jira ticket with the description of the problem. The priority should be Minor for most things, and only Major if it is fixing a bug that prevents something from working as expected. The component should be deployment for new charms or bundles, as well as for changes to the puppet manifests.

  2. Create branch in the juju-solutions/bigtop fork named [bug|feature]/BIGTOP-XXXX/description, where XXXX is the Jira ticket number, e.g. bug/BIGTOP-2548/xenial-charm-refresh.

  3. Commit the change with a commit message of the form BIGTOP-XXXX: message. NOTE: message must match the title of your JIRA ticket. Then push it to the branch you created above. E.g. cc3eb9d.

  4. Open a pull request from your branch to the upstream Apache Bigtop repository, e.g. PR 148. Again, ensure the PR title exactly matches the title of your Jira ticket prefixed by the BIGTOP-XXXX ticket number.

  5. Refresh your Jira ticket. You should see your GitHub PR linked to the ticket. You should also see a comment by ASF GitHub Bot with information about the PR which includes a link to the PR's patch file, which is the PR URL with .patch appended to it. For example, BIGTOP-2469 contains a link to https://github.com/apache/bigtop/pull/113.patch. Once you do, click the Submit Patch button in the ticket to inform committers that this ticket has a Patch Available.

  6. Commit the patch file to the master branch of the layer-apache-bigtop-base repository alongside the other patches using the BIGTOP-XXXX.patch naming convention. This step ensures your patch is used during the next charm build, regardless of when the fix is committed upstream.

If changes need to be made in the patch, make sure that you use git commit --amend so that the branch only has a single commit with the correct patch and then git push --force to replace the previous commit with the new one.