UCLA Git Walkthrough (for Moodle)

Very basic guide how to get GIT set up on Windows or OSX.

Documentation:

Setting up the Environment

Configure Line Endings

  • In order to avoid issues with line endings when cloning on to Windows machines, follow the directions here: Dealing with line endings

Setting up Git global configs

Before making commits, it is useful to add your name and email:

  • git config --global user.name "Your Name"
  • git config --global user.email "Your email address"

Set these git config settings

  • git config --global push.default current // only push current branch to remote
  • git config core.ignorecase false // makes sure that git is case sensitive
  • git config --global pull.rebase true // rebase by default when doing a pull

If you want to connect to github without SSH you need a token:

Setting up your Github repository:

Clone the repository

Work on a new feature/task

Our workflow is similar to the workflow mentioned in this article: http://nvie.com/posts/a-successful-git-branching-model/

Name your git branch using our naming convention:

  • type/jira ticket-short description
  • The type, for now, should either be:
    • feature (something that has never existed before or an improvement to a current feature)
    • patch (a bug fix, can either come from internal or external sources)
    • tests (For Behat or PHPunit only branches)
    • update (reserved for core Moodle version and external plugin updates)
  1. git checkout master
  2. git pull origin master
  3. git submodule init && git submodule update
  4. git checkout -b feature/CCLE-<JIRA ticket number>-<feature-name>
  5. Repeat the following steps as necessary:
    • - change file(s) -
    • git commit -a -m "CCLE-#### - A useful short comment summarizing what you did."
  6. git push -u origin <branch_name>
  7. Merge task onto TEST
    1. git checkout development
    2. git pull origin development
    3. git merge --no-ff <branch_name>
    4. git push origin development

-Start- TEST machine ONLY

At this point, there could be more than one feature that is being tested! Once a feature/patch has passed testing, then merge it to the rc branch.

Creating rc branch

  1. git checkout master
  2. git checkout -b <release_number>-rc
  3. Now merge in several branches with fixes/features that passed review
    1. git merge --no-ff feature/<feature_name>
    2. git push -u origin <release_number>-rc

-End- On TEST machine ONLY

-Start- On STAGE machine ONLY

  1. git checkout -b <release_number>-rc origin/<release_number>-rc
  2. Once rc passes testing on TEST/STAGE, merge it into master so it can go to prod

-End- On STAGE machine ONLY

Once the feature(s) has been successfully test on STAGE and is ready for PROD:

  • The numbers M.m.v.rr should be the same as the numbers for the RC branch.
  • git checkout master
  • git merge --no-ff origin/<release_number>-rc -m "Release <release_number>-gm: Description of what was in this release/use JIRA version description"
  • git push origin master
  • git tag M.m.v.rr-gm -m "Release <release_number>-gm: Description of what was in this release/use JIRA version description"
  • git push origin master
  • git push origin M.m.v.rr-gm

    -Start- On PROD machine ONLY

    • The numbers M.m.v.rr should be the same as the numbers for the RC branch.
  • git fetch
  • git checkout M.m.v.rr-gm
  • Validate things are working…
  • Finished with release cycle!

    -End- On PROD machine ONLY

    Push a bug fix/hot fix

    1. git checkout master
    2. git checkout -b patch/CCLE-####
    3. Repeat until you have the bug fixed in your working instance:
      1. - change file(s) -
      2. git commit -a -m "CCLE-#### - Description of bug fix."
      3. git push origin master
    4. Once the bug has passed code and administrative review you can then merge to master directly and deploy master on PROD
      1. git fetch origin master:master
      2. git checkout master

    Pulling from a version from Moodle.org

    1. git checkout -b update/M.m.v
    2. git remote add core https://github.com/moodle/moodle.git
    3. git fetch core
    4. git merge -Xtheirs -m "CCLE-<ticket> - Upgrade to Moodle M.m.v" <version tag>
      1. Might first want to try without the -Xtheirs if upgrading between minor versions.
    5. Resolve conflicts
      1. git add <conflicted_file>
      2. If needed, continue the merge
    6. Finish the pull.
      • Push to development, test on TEST, push to STAGE then release on PROD.
    7. Be sure to notate the new RC and GM tags with the updated Moodle version M.m.v.00
    8. To upgrade to a major release of Moodle, follow the instructions in this guide: http://tjhunt.blogspot.com/2014/01/moving-ou-moodle-code-to-moodle-261.html