Meta: set up the architecture for commit/branch snapshots

.gitignore

@@ -0,0 +1,4 @@
+/dom.spec.whatwg.org/
+deploy_key
+deploy_key.pub
+dom.html

.travis.yml

@@ -0,0 +1,7 @@
+language: generic
+
+env:
+  global:
+    - ENCRYPTION_LABEL: "0a03797be0f9"
+script:
+  - bash ./deploy.sh

Makefile

@@ -0,0 +1,5 @@
+local: dom.bs
+	bikeshed spec dom.bs dom.html --md-Text-Macro="SNAPSHOT-LINK LOCAL COPY"
+
+remote: dom.bs
+	curl https://api.csswg.org/bikeshed/ -f -F [email protected] > dom.html -F md-Text-Macro="SNAPSHOT-LINK LOCAL COPY"

README.md

@@ -25,12 +25,14 @@ reading through the [WHATWG FAQ](https://wiki.whatwg.org/wiki/FAQ) if you are ne
 Please add your name to the Acknowledgments section in your first pull request, even for trivial
 fixes. The names are sorted lexicographically.
 
-To generate `dom.html`, [bikeshed](https://github.com/tabatkins/bikeshed) can be used. Do not worry
-if using that tool is too complicated; your pull request does not need to contain the generated HTML
-to be accepted. If you _do_ want to use it, the easiest way is probably via the HTTP API:
+If you want to preview the spec locally, you can either use a locally installed copy of
+[Bikeshed](https://github.com/tabatkins/bikeshed) by running `make` or use the HTTP API version by
+running `make remote`.
+
+If you want to do a complete "local deploy" including commit and/or branch snapshots, run
 
 ```
-curl https://api.csswg.org/bikeshed/ -f -F [email protected] > dom.html
+./deploy.sh --local
 ```
 
 #### Formatting

deploy.sh

@@ -0,0 +1,94 @@
+#!/bin/bash
+set -e
+
+DEPLOY_USER="annevankesteren"
+
+TITLE="DOM Standard"
+LS_URL="https://dom.spec.whatwg.org/"
+COMMIT_URL_BASE="https://github.com/whatwg/dom/commit/"
+BRANCH_URL_BASE="https://github.com/whatwg/dom/tree/"
+
+INPUT_FILE="dom.bs"
+SERVER="dom.spec.whatwg.org"
+WEB_ROOT="dom.spec.whatwg.org"
+COMMITS_DIR="commit-snapshots"
+BRANCHES_DIR="branch-snapshots"
+TESTS_DIR="tests"
+
+if [ "$1" != "--local" -a "$DEPLOY_USER" == "" ]; then
+    echo "No deploy credentials present; skipping deploy"
+    exit 0
+fi
+
+if [ "$1" == "--local" ]; then
+    echo "Running a local deploy into $WEB_ROOT directory"
+    echo ""
+fi
+
+SHA="`git rev-parse HEAD`"
+BRANCH="`git rev-parse --abbrev-ref HEAD`"
+if [ "$BRANCH" == "HEAD" ]; then # Travis does this for some reason
+    BRANCH=$TRAVIS_BRANCH
+fi
+
+if [ "$BRANCH" == "master" -a "$TRAVIS_PULL_REQUEST" != "false" -a "$TRAVIS_PULL_REQUEST" != "" ]; then
+    echo "Skipping deploy for a pull request; the branch build will suffice"
+    exit 0
+fi
+
+BACK_TO_LS_LINK="<a href=\"/\" id=\"commit-snapshot-link\">Go to the living standard</a>"
+SNAPSHOT_LINK="<a href=\"/commit-snapshots/$SHA/\" id=\"commit-snapshot-link\">Snapshot as of this commit</a>"
+
+echo "Branch = $BRANCH"
+echo "Commit = $SHA"
+echo ""
+
+rm -rf $WEB_ROOT || exit 0
+
+# Commit snapshot
+COMMIT_DIR=$WEB_ROOT/$COMMITS_DIR/$SHA
+mkdir -p $COMMIT_DIR
+curl https://api.csswg.org/bikeshed/ -f -F file=@$INPUT_FILE -F md-status=LS-COMMIT \
+     -F md-warning="Commit $SHA $COMMIT_URL_BASE$SHA replaced by $LS_URL" \
+     -F md-title="$TITLE (Commit Snapshot $SHA)" \
+     -F md-Text-Macro="SNAPSHOT-LINK $BACK_TO_LS_LINK" \
+     > $COMMIT_DIR/index.html;
+echo "Commit snapshot output to $WEB_ROOT/$COMMITS_DIR/$SHA"
+echo ""
+
+if [ $BRANCH != "master" ] ; then
+    # Branch snapshot, if not master
+    BRANCH_DIR=$WEB_ROOT/$BRANCHES_DIR/$BRANCH
+    mkdir -p $BRANCH_DIR
+    curl https://api.csswg.org/bikeshed/ -f -F file=@$INPUT_FILE -F md-status=LS-BRANCH \
+         -F md-warning="Branch $BRANCH $BRANCH_URL_BASE$BRANCH replaced by $LS_URL" \
+         -F md-title="$TITLE (Branch Snapshot $BRANCH)" \
+         -F md-Text-Macro="SNAPSHOT-LINK $SNAPSHOT_LINK" \
+         > $BRANCH_DIR/index.html;
+    echo "Branch snapshot output to $WEB_ROOT/$BRANCHES_DIR/$BRANCH"
+else
+    # Living standard, if master
+    curl https://api.csswg.org/bikeshed/ -f -F file=@$INPUT_FILE \
+         -F md-Text-Macro="SNAPSHOT-LINK $SNAPSHOT_LINK" \
+         > $WEB_ROOT/index.html
+    echo "Living standard output to $WEB_ROOT"
+fi
+
+echo ""
+find $WEB_ROOT -print
+echo ""
+
+if [ "$1" != "--local" ]; then
+    # Get the deploy key by using Travis's stored variables to decrypt deploy_key.enc
+    ENCRYPTED_KEY_VAR="encrypted_${ENCRYPTION_LABEL}_key"
+    ENCRYPTED_IV_VAR="encrypted_${ENCRYPTION_LABEL}_iv"
+    ENCRYPTED_KEY=${!ENCRYPTED_KEY_VAR}
+    ENCRYPTED_IV=${!ENCRYPTED_IV_VAR}
+    openssl aes-256-cbc -K $ENCRYPTED_KEY -iv $ENCRYPTED_IV -in deploy_key.enc -out deploy_key -d
+    chmod 600 deploy_key
+    eval `ssh-agent -s`
+    ssh-add deploy_key
+
+    # scp the output directory up
+    scp -r -o StrictHostKeyChecking=no $WEB_ROOT $DEPLOY_USER@$SERVER:
+fi

dom.bs

@@ -8,6 +8,7 @@ No Editor: true
 !Participate: <a href=https://github.com/whatwg/dom>GitHub whatwg/dom</a> (<a href=https://github.com/whatwg/dom/issues/new>new issue</a>, <a href=https://github.com/whatwg/dom/issues>open issues</a>, <a href=https://www.w3.org/Bugs/Public/buglist.cgi?component=DOM&amp;product=WebAppsWG&amp;resolution=--->legacy open bugs</a>)
 !Participate: <a href=https://wiki.whatwg.org/wiki/IRC>IRC: #whatwg on Freenode</a>
 !Commits: <a href=https://github.com/whatwg/dom/commits>GitHub whatwg/dom/commits</a>
+!Commits: [SNAPSHOT-LINK]
 !Commits: <a href=https://twitter.com/thedomstandard>@thedomstandard</a>
 !Translation (non-normative): <span title=Japanese><a href=https://triple-underscore.github.io/DOM4-ja.html lang=ja hreflang=ja rel=alternate>日本語</a></span>
 Logo: https://resources.whatwg.org/logo-dom.svg