Instructor git workflow

The examples use csci265 and assign1 as the course and assignment ids and crazydude as a student loginid.

Before semester

• Let Merlin know at start of semester which courses to use it for
  Merlin will set up necessary voodoo for registered students
  *** when new students register after start of term let Merlin know so he can do necessary voodoo for them too ***
• mkdir ~/csci265 to create instructors course storage location
• mkdir -p ~/marking/csci265

Setting up an assignment

• create an empty central repository for the assignment
  gits addassign csci265 assign1
• set a deadline: (otherwise the students cannot submit)
  gits setdeadline csci265 assign1 2015-10-24 09:00
• set a deadline for a specific individual (extensions etc):
  gits setdeadline csci265 assign1:crazydude 2015-10-31 09:00
• Set up the local repository as a clone of your (empty) central one
  cd ~/csci265
  git clone csci:csci265/assign1

Adding assignment content

• Change/add content as needed, then push to central repository:
  git add .
  git commit -m "....."
  git push

  Note that to push a branch use git push origin BRANCHNAME To see available branches use git branch -a

• If the students have already forked (i.e. after assignment release) don't forget to remind them of the process to fetch any updates you push.

Notes on gits

• gits from home directory on owl, gives command summary
• gits listrepo lists course repositories
• gits listassign csci265 lists assignments I've created for 265 so far
• gits listdeadline csci265 assign1 lists deadline for the assignment

Marking submissions

• To pull all the student submissions for an assignment:
  cd ~/marking
  gits checkout csci265 assign1
  (this pulls the current state of each student's central repository, putting them into a subdirectory csci265/loginid/assignment)

• To pull just one student's submission (for a student with login id crazydude)
  cd to ~/marking/csci265/crazydude
  git clone csci:/csci265/crazydude/assign1

• To get a list of what other branches they've created (e.g. from inside assign1 repo)
  git branch -a

• To pull a specific branch from a submission, use
  git clone csci:/csci265/crazydude/assign1 --branch branchname

  ...and to store that in a specific directory, use
  git clone csci:/csci265/crazydude/assign1 --branch branchname dirname

• If the student resubmits the work, or you did a checkout before they did their submit, then you can add a remote, do a fetch to get the changes since your "gits checkout", and then checkout the resubmitted version, e.g. (assuming main branch)
  git remote add resubmit csci:/csci265/crazydude/assign1
  git fetch resubmit
  git checkout resubmit/master

  Note: "master" can be replaced with "main" as the name of the core branch after an initial commit in the repo, using the command git branch -M main Unfortunately that isn't quite compatible with our git submit structure yet, so I've left the "master" terminology in place

  Note: handling late submissions can be a bit tedious manually, so I've put together a script that will check each repository and pull any that have changed since you did the checkout. The only drawback is that it only checks repositories that had actually been forked by the student before you did the checkout (e.g. if you do your checkout after the submission deadline, then a student does their fork/clone/edit/submit, the script won't detect their submission.

  It isn't pretty or robust, but it's functional, sample usage is:

  pullChanges.sh csci330 lab6

  #! /bin/bash if [ $# -lt 2 ] ; then echo "correct use is" echo " $0 course item" echo "e.g. $0 csci265 lab1" echo "...assumes you have previously done a" echo " gits checkout course item" echo "from this same directory" exit 0 fi repo=$2 course=$1 top=$PWD for student in ${course}/*/${repo} ; do cd ${student} echo "${student}" git pull d=$(git log -1 --format=%cd 2>1& ) echo "${d}" echo " " cd ${top} done

  ---

  Providing feedback through gits

  You can create and update grade repositories for each of the students as follows:

  • Setup a grades directory someplace, with a subdirectory for your course, e.g.
    mkdir -p grading/csci330

  • Create the student grade repositories server-side, e.g.
    gits addgrades csci330 projectFeedback

  • Checkout the student repositories, e.g.
    cd grading
    gits checkout csci330 projectFeedback

  • Put whatever feedback you like in the student repositories, then (for an individual student) in their directory do the usual
    git add .
    git commit -m "your favorite commit message"
    git push

    Note the add/commit/push sequence can get pretty tedious if you have 60+ students, so here's a script that will add/commit/push all of them at once after you've finished putting feedback in the student directories.

    Sample usage is:

    pushChanges.sh csci330 projectFeedback

    #! /bin/bash if [ $# -lt 2 ] ; then echo "correct use is" echo " $0 course item" echo "e.g. $0 csci265 lab1" echo "...assumes you have previously done a" echo " gits checkout course item" echo "from this same directory" exit 0 fi repo=$2 course=$1 top=$PWD commitMsg="marks and feedback" for student in ${course}/*/${repo} ; do cd ${student} echo "${student}" git add . git commit -m "${commitMsg}" git push cd ${top} done