Meta: enable snapshots

.gitignore

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

.travis.yml

@@ -0,0 +1,18 @@
+language: generic
+
+env:
+  global:
+    - ENCRYPTION_LABEL: "4e018593088f"
+addons:
+  apt:
+    packages:
+      - oracle-java8-set-default
+install:
+  - curl -O https://sideshowbarker.net/nightlies/jar/vnu.jar
+script:
+  - bash ./deploy.sh
+  - /usr/lib/jvm/java-8-oracle/jre/bin/java -jar vnu.jar --skip-non-html /home/travis/build/whatwg/notifications
+notifications:
+  email:
+    on_success: never
+    on_failure: always

Makefile

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

README.md

@@ -8,19 +8,30 @@ respect the [WHATWG Code of Conduct](https://wiki.whatwg.org/wiki/Code_of_Conduc
 
 ### Contribution opportunities
 
-Folks notice minor and larger issues with the DOM Standard all the time and we'd love your help
-fixing those. Pull requests for typographical and grammar errors are also most welcome.
+Folks notice minor and larger issues with the Notifications API Standard all the time and we'd love
+your help fixing those. Pull requests for typographical and grammar errors are also most welcome.
 
 We'd be happy to mentor you through this process. If you're interested and need help getting
 started, leave a comment on the issue or ask around [on IRC](https://wiki.whatwg.org/wiki/IRC).
 
 ### Pull requests
 
-See the [html repository's README](https://github.com/whatwg/html/blob/master/README.md) for the
-general guidelines. Note that `source` is `Overview.src.html` and "Acknowledgements" is
-"Acknowledgments" here (I know). Also, the Notifications API Standard uses
-[bikeshed](https://github.com/tabatkins/bikeshed) to generate `notifications.html`. (Do not worry if
-using that tool is too complicated, your pull request does not need to contain the generated HTML.)
+In short, change `notifications.bs` and submit your patch, with a
+[good commit message](https://github.com/erlang/otp/wiki/Writing-good-commit-messages). Consider
+reading through the [WHATWG FAQ](https://wiki.whatwg.org/wiki/FAQ) if you are new here.
+
+Please add your name to the Acknowledgments section in your first pull request, even for trivial
+fixes. The names are sorted lexicographically.
+
+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
+
+```
+./deploy.sh --local
+```
 
 ### Merge policy
 

deploy.sh

@@ -0,0 +1,93 @@
+#!/bin/bash
+set -e
+
+DEPLOY_USER="annevankesteren"
+
+TITLE="Notifications API Standard"
+LS_URL="https://notifications.spec.whatwg.org/"
+COMMIT_URL_BASE="https://github.com/whatwg/notifications/commit/"
+BRANCH_URL_BASE="https://github.com/whatwg/notifications/tree/"
+
+INPUT_FILE="notifications.bs"
+SERVER="notifications.spec.whatwg.org"
+WEB_ROOT="notifications.spec.whatwg.org"
+COMMITS_DIR="commit-snapshots"
+BRANCHES_DIR="branch-snapshots"
+
+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

notifications.bs

@@ -11,11 +11,13 @@ Boilerplate: omit feedback-header, omit conformance
 !Participate: <a href=https://github.com/whatwg/notifications>GitHub whatwg/notifications</a> (<a href=https://github.com/whatwg/notifications/issues/new>new issue</a>, <a href=https://github.com/whatwg/notifications/issues>open issues</a>)
 !Participate: <a href=https://wiki.whatwg.org/wiki/IRC>IRC: #whatwg on Freenode</a>
 !Commits: <a href="https://github.com/whatwg/notifications/commits">GitHub whatwg/notifications/commits</a>
+!Commits: [SNAPSHOT-LINK]
 !Commits: <a href="https://twitter.com/notifyapi">@notifyapi</a>
 !Translation (non-normative): <span title="Simplified Chinese"><a href=https://w3c-html-ig-zh.github.io/notifications/whatwg/ lang=zh hreflang=zh rel=alternate>简体中文</a></span>
 </pre>
 
 <script src=https://resources.whatwg.org/file-issue.js async></script>
+<script src=https://resources.whatwg.org/commit-snapshot-shortcut-key.js async></script>
 <script src=https://resources.whatwg.org/dfn.js defer></script>
 
 <h2 id=terminology>Terminology</h2>