Changes between Version 2 and Version 3 of control-panel/common-tasks


Ignore:
Timestamp:
Jan 4, 2014, 7:34:40 PM (7 years ago)
Author:
Drew Hornbein
Comment:

tellin' my peeps all about updating to the dev server.

Legend:

Unmodified
Added
Removed
Modified
  • control-panel/common-tasks

    v2 v3  
    11= Common tasks UI Improvements =
     2
     3== Setting up your local git environment ==
     4
     5To get started you simply need to clone the red repo and install red.
     6
     7To clone red try: `git clone gitosis@git.mayfirst.org:mfpl/red`
     8
     9[https://support.mayfirst.org/wiki/control-panel/hacking/install Read the installation instructions here]
     10
     11== Using git ==
     12
     13If you're just editing a few lines of code and suspect it will only take you a single commit to work your magic, just make the commit to the `dev` branch. Be sure to leave a good commit comment, perferably with the ticket number you're fixing (ex: `git commit -m "added reset password dialog fix #8175"`)
     14
     15If your edits might require more than one commit create a new branch `git checkout -b ticket_0000` (this command will create a new branch then switch to it). Remember, you can make a new branch any time while editing the code!
     16
     17It is suggested that you name the branch after the ticket number you are working on (eg `git branch ticket_1234`).
     18
     19If you aren't working on a ticket then prefix your branch name with your initials. (eg `dh_new_branch`)
     20
     21=== Understanding red dev git branches ===
     22
     23We use the `master` branch for stable ''tested'' code.
     24
     25The `dev` branch is for development code, you should merge your working branch into dev on your local machine then push it to the git repo so that you only have to pull down the `dev` branch on the server.
    226
    327== Pushing changes to Red development environment ==
    428
    5 The red development environment lives at [https://red.dev.mayfirst.org/]
     29Note: If you have a MayFirst account and would like access to the dev hosting order please issue a ticket to `https://id.mayfirst.org/drew` and ask politely.
     30
     31The red development environment lives at [https://red.dev.mayfirst.org/] on rose.mayfirst.org.
     32
     33This environment pulls from the red github repo at `git://git.mayfirst.org/mfpl/red`
     34
     35To pull updates simply log in to the red.dev.mayfirst.org hosting order using `ssh red.dev@rose.mayfirst.org`
     36
     37Then use the following commands:
     38
     39{{{
     40cd red.dev.mayfirst.org/web/
     41git checkout dev #this will ensure that you're on the dev branch
     42git pull
     43git merge origin/dev
     44}}}
     45
     46If all goes well you should see the changes on [https://red.dev.mayfirst.org/]. Remember to do a "hard refresh" using ctrl+shift+R (command+shift+R for mac) on most browsers. This will ensure that you overwrite any supplementary files (like css) in your browsers cache.
     47
     48Once your changes are live on dev be sure to have people review the changes. If they appear to be stable then we can take them live. See instructions below.
     49
     50=== Testing unstable changes ===
     51
     52If you have some crazy experimental changes you want to test please set the dev environment to a different branch. Here's an example:
     53
     54On the red.dev.mayfirst.org server:
     55{{{
     56cd red.dev.mayfirst.org/web/
     57git pull origin you_branch_name
     58git checkout your_branch_name
     59}}}
     60
     61Then you'll be able to view your experimental changes on [https://red.dev.mayfirst.org/].
     62
     63When you're done testing please set the git back to the `dev` branch using the command `git checkout dev`.
     64
     65== When your code is ready for prime time ==
     66
     67Once you've thoughly tested and shared your changes from the dev branch and everyone is happy with the great work you've done feel free to merge your changes into the master branch and push those changes to the red dev repo. This process should look something like this:
     68
     69{{{
     70git checkout master
     71git merge dev
     72git push origin master
     73}}}