Versions Compared

Old Version 4

changes.mady.by.user Hugo Trippaers

Saved on

compared with

New Version Current

changes.mady.by.user Remi Bergsma

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

This is a proposed way of working, under discussion on the mailing list. See http://markmail.org/message/xoyjw2sduenlytwm

Commit to master through PR only was decided on here: http://comments.gmane.org/gmane.comp.apache.cloudstack.devel/62223

Summary

Apache CloudStack is a broad and encompassing project covering many areas that require in-depth technical knowledge.  As such, it is not possible for one person to know and/or test all components of CloudStack in depth.  Miscommunications and misunderstandings between developers can lead to poor quality in CloudStack's code and cause community to deliver a unstable release.  Knowledge lost from one release to the next can cause regressions in the current release.  This page details the development process the CloudStack community must follow in order to ensure the community delivers high quality releases.  This page is a must read for all developers and testers.

...

The process is very simple.

  1. Create a branch for your code or the patch you're helping to submit (Use github Fork the code on Github and send a pull request (even if you are not yet a committer)
  2. Assign the JIRA issue to yourself, change the status to "In Progress", add the branch information into the issue.
  3. When the work is completed, do the following things.
    1. Arrange for a review with two colleagues.
    2. Send the pull request and then ask two colleagues to review and give their "LGTM".
    3. Testing will be done on your pull request, the Travis CI output will appear on the pull request.Use Jenkins to ask automation be run on your branch. (Steps below)
  4. Once review and automation are completed successfully, a committer will merge the branch to the release branch or master. 
  5. Once the merge is completed, change the status of the issue to "Resolved."

...

  • It is up to the developer to find the right people to review his/her code changes.  
  • It is within the reviewer's right to decide whether they are the appropriate reviewer for a code change.  
  • If they are not or if the review requires technical expertise from others, the reviewer can either refer the developer to another reviewer or pull in another reviewer.

...

Automated tests ensures that your feature will not be regressed.  Anyone who submits a code change that breaks an existing automated test is responsible for fixing that automated test or revert the code change. 

Q&A

Q: I'm a contributor and not a committer.  How do I participate in this process?

A: You can send a pull request on github. When two other collaborators give a LGTM, a committer will merge your pull request.

Q: Who is providing this jenkins?

A: Currently, the jenkins instance will be provided by Citrix, mainly because we're still working out an infrastructure testing lab in ASF.  When that is ready, Citrix is willing to donate the setup necessary to run continuous integration to ASF.

Q: I like to set this up in my own organization so that we can run CI on our own development branches.  Can I do this?

A: The setup itself is publicly available.  The people who made this possible: Amogh, Bharat, Santhosh, are all on the mailing list.  You can communicate with them via the mailing list and ask them help you with the setup.  We will try to document this setup as much as possible once it's available.

Q: I currently have a Jenkins slave that runs tests for my own code on every build.  Can you add my slave to your jenkins?

A: Currently, no.  There's a lot of issues involving jenkins in Citrix making call to outside of Citrix that really I'm not willing to go resolve.  For now, you just have to run that with the ASF jenkins.