Changes between Version 3 and Version 4 of SprintGettingStarted


Ignore:
Timestamp:
Jan 4, 2017, 1:57:28 AM (18 months ago)
Author:
rutsky
Comment:

swap "eight" and "nine" branches approach + rename "slave" to "worker"

Legend:

Unmodified
Added
Removed
Modified
  • SprintGettingStarted

    v3 v4  
    2424cd src
    2525pip install -e master
    26 pip install -e slave
     26pip install -e worker
    2727}}}
    2828
     
    3434== The Source ==
    3535
    36 Have a look around in `src/`.  You'll find all of the code for the buildmaster under `master/`, and likewise for `slave/`.  Docs are under `master/docs` in reStructuredText format, which is pretty intuitive.  Unit tests are located under `master/test/unit`, in a file named after the file they're testing, e.g., `master/buildbot/process/properties.py` is tested by `master/buildbot/test/unit/test_process_properties.py`.  Run the unit tests now, just to make sure you're starting from a solid base of passing tests:
     36Have a look around in `src/`.  You'll find all of the code for the buildmaster under `master/`, and likewise for `worker/`.  Docs are under `master/docs` in reStructuredText format, which is pretty intuitive.  Unit tests are located under `master/test/unit`, in a file named after the file they're testing, e.g., `master/buildbot/process/properties.py` is tested by `master/buildbot/test/unit/test_process_properties.py`.  Run the unit tests now, just to make sure you're starting from a solid base of passing tests:
    3737{{{
    38 trial buildbot.test buildslave.test
     38trial buildbot.test buildbot_worker.test
    3939}}}
    4040Note that you can also run `pyflakes master/buildbot` to detect any small Python syntax issues.
     
    4242Before you get started making changes, check out a git branch named after what you're working on.  This can be `bug1234` or `new-cool-stuff` or whatever you'd like -- just avoid `master`.
    4343{{{
    44 git checkout -b new-cool-stuff upstream/master  # if you're working on Buildbot-0.8.x, or
    45 git checkout -b new-cool-stuff upstream/nine    # if you're working on Buildbot-0.9.x
     44git checkout -b new-cool-stuff upstream/master  # if you're working on Buildbot-0.9.x, or
     45git checkout -b new-cool-stuff upstream/eight   # if you're working on Buildbot-0.8.x
    4646}}}
    4747Git makes it easy to have multiple branches in the same repository and switch between them, but that's getting ahead of things for now.
     
    6060Now, back to your patch.  Run `git status` to make sure that only the files you want have been changed.  Run `git branch` to make sure you're on the right branch.  Run `git add .` to add everything, and then run `git diff --cached` to get a preview of the patch.  If everything looks OK, run `git commit` to commit it locally.
    6161
    62 Once that's in shape, run `git push origin <branchname>` to push the changes to your Github repository.  Use the same branch name as you used locally.  Then open your repository up in your browser (http://github.com/YOURNAME/buildbot) and you will see your branch with a "Pull Request" button next to it.  Click that button.  IMPORTANT: if you're working on Buildbot-0.9.x, tell Github that the pull is against base branch 'nine', or your pull request will include a lot more commits than you want.  Type a nice message describing the patch to the people who will be reviewing it.
     62Once that's in shape, run `git push origin <branchname>` to push the changes to your Github repository.  Use the same branch name as you used locally.  Then open your repository up in your browser (http://github.com/YOURNAME/buildbot) and you will see your branch with a "Pull Request" button next to it.  Click that button.  IMPORTANT: if you're working on Buildbot-0.8.x, tell Github that the pull is against base branch 'eight', or your pull request will include a lot more commits than you want.  Type a nice message describing the patch to the people who will be reviewing it.
    6363
    6464The reviewers may ask you to make some additional changes.  The easiest way to do so is to make the requested changes and repeat the part above with `git status`, `git branch`, etc.  Don't forget to make sure the tests still pass!  Once your patch is accepted, you're done!