README.SIPB

   1 README for SIPB maintainers
   2
   3 Basic instructions on scripts of interest. Also,
   4 How this repository is set up, and how to keep IkiWiki up to date.
   5
   6
   7 Setup:
   8
   9 There are three branches of interest: remotes/origin/master, master
  10 and sipb.  remotes/origin/master is the remote branch we are tracking;
  11 all upstream changes show up in this branch when we `git fetch`.
  12
  13 master is our "awaiting upstream approval" branch, based off of
  14 remotes/origin/master. Any patches in this branch should be immediately
  15 suitable for submission to IkiWiki maintainers/. Ideally, this branch
  16 should be equivalent to remotes/origin/master.
  17
  18 sipb is our live branch. It contains all of the ugly hacks and custom
  19 modifications that we needed to make our website run. Ideally, this
  20 branch is equivalent to master. Don't expect it to be without a lot
  21 of rearchitecting and upstream cooperation.
  22
  23
  24 Keeping up to date:
  25
  26     XXX: This shouldn't be done anymore, as we now have a bare repository.
  27     New instructions for syncing should be upcoming.
  28
  29 This two-tiered setup means that you will need to rebase twice in order
  30 to propagate changes; possibly once if master == origin/master. Your
  31 commands will look like this:
  32
  33 $ git checkout origin
  34 if master == remotes/origin/master:
  35   $ git pull
  36 else
  37   $ git fetch
  38   $ git rebase origin/master
  39 fi
  40 $ git checkout sipb
  41 $ git rebase master
  42
  43 TODO: Make a script that does this.
  44
  45
  46 Scripts:
  47
  48 The source repository has a hook that automatically deploys changes when
  49 you push to it.  If bad things happen, however, there are two scripts of
  50 interest:
  51
  52 ~/bin/reinstall-ikiwiki
  53     This script runs make and make install, reinstalling the source files to
  54     make it live.
  55
  56 ~/bin/update-ikiwiki
  57     This script recompiles the website from its source directory
  58     ikiwiki/src into the live wiki directory web_scripts/wiki.
  59
  60 Normally, these don't need to be run.
  61