Welcome to 2019
[ikiwiki.git] / 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 is what we'd do in our original clone of upstream.
27   How do we do this now that we have our own internal repo to clone?
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 master
34 $ git pull --rebase
35 $ git checkout sipb
36 $ git rebase master
37
38 TODO: Make a script that does this.
39
40
41 Scripts:
42
43 The source repository has a hook that automatically deploys changes when
44 you push to it.  If bad things happen, however, there are two scripts of
45 interest:
46
47 ~/bin/reinstall-ikiwiki
48     This script runs make and make install, reinstalling the source files to
49     make it live.
50
51 ~/bin/update-ikiwiki
52     This script recompiles the website from its source directory
53     ikiwiki/src into the live wiki directory web_scripts/wiki.
54
55 Normally, these don't need to be run.
56