Timestamp manuscripts with OpenTimestamps (#274)

Closes greenelab/deep-review#269
greenelab · Mar 4, 2017 · 3b763ff · 3b763ff
1 parent bc72855
commit 3b763ff
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,7 @@
 # Generated manuscript output files
 output/index.html
 output/deep-review.pdf
+output/*.ots
 
 # Generated reference files
 references/generated/*

diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "ci/opentimestamps-client"]
+	path = ci/opentimestamps-client
+	url = https://github.com/opentimestamps/opentimestamps-client.git
diff --git a/build/environment.yml b/build/environment.yml
@@ -12,3 +12,4 @@ dependencies:
     - arxiv2bib==1.0.7
     - bibtexparser==0.6.2
     - ghp-import==0.5.5
+    - python-bitcoinlib==0.7.0
diff --git a/ci/deploy.sh b/ci/deploy.sh
@@ -1,5 +1,15 @@
+# Exit on errors
 set -o errexit
 
+# Add commit hash to the README
+envsubst < output/README.md > output/README.md
+
+# Generate OpenTimestamps
+python ci/opentimestamps-client/ots stamp \
+  output/index.html \
+  output/deep-review.pdf \
+  output/README.md
+
 # Configure git
 git config --global push.default simple
 git config --global user.email `git log --max-count=1 --format='%ae'`

diff --git a/ci/opentimestamps-client b/ci/opentimestamps-client
diff --git a/output/README.md b/output/README.md
@@ -0,0 +1,18 @@
+# Output directory containing the formatted manuscript
+
+The [`gh-pages`](https://github.com/greenelab/deep-review/tree/gh-pages) branch hosts the contents of this directory at https://greenelab.github.io/deep-review/.
+
+## Files
+
+This directory contains the following files, which are mostly ignored on the `master` branch:
+
++ [`index.html`](index.html) is an HTML manuscript.
++ [`github-pandoc.css`](github-pandoc.css) sets the display style for `index.html`.
++ [`deep-review.pdf`](deep-review.pdf) is a PDF manuscript.
++ `*.ots` files are OpenTimestamps which can be used to verify manuscript existence at or before a given time.
+  [OpenTimestamps](opentimestamps.org) uses the Bitcoin blockchain to attest to file hash existence.
+
+## Source
+
+The manuscripts in this directory were built from
+[`$TRAVIS_COMMIT`](https://github.com/greenelab/deep-review/commit/$TRAVIS_COMMIT).