Merge pull request #600 from LSSTScienceCollaborations/issue/593/release

Include most recent commit ID, release version, on front page

Author: drphilmarshall

.gitignore

@@ -21,6 +21,7 @@ LSST_Observing_Strategy_White_Paper.pdf
 # *.ps
 # *.eps
 # *.pdf
+thisversion.tex
 
 ## Bibliography auxiliary files (bibtex/biblatex/biber):
 *.bbl

.travis.yml

@@ -1,17 +1,18 @@
 language: ruby
 rvm:
-- 1.9.3
+  - 1.9.3
 script: /bin/bash whitepaper/travis.sh
 # Install LaTeX. This usually takes ~1 hour... 
 before_install:
-- yes "" | sudo apt-add-repository ppa:texlive-backports/ppa
-- sudo apt-get update -y
-- sudo apt-get install -y
-     inkscape
-     texlive-fonts-recommended
-     texlive-latex-extra
-     texlive-latex-recommended
-     texlive-xetex
+  - sudo apt-get install -qq bc tcsh
+  - yes "" | sudo apt-add-repository ppa:texlive-backports/ppa
+  - sudo apt-get update -y
+  - sudo apt-get install -y
+       inkscape
+       texlive-fonts-recommended
+       texlive-latex-extra
+       texlive-latex-recommended
+       texlive-xetex
 # Finally, if it's the master branch being updated, force-push the
 # resulting PDF to an otherwise empty "pdf" branch:
 after_success: |

README.md

@@ -4,7 +4,11 @@ Welcome to the online community thinking about LSST survey strategy ("cadence"),
 
 We are writing a white paper on this topic, primarily composed of a set of individual science cases that are either very important, and somehow stress the observing strategy, and describing how we expect them to be sensitive to LSST observing strategy. MAF metric calculations are then being designed and implemented: these form the quantitative backbone of the document. You may have heard of the coming  "Cadence Wars" - this white paper represents the "Cadence Diplomacy" that will allow us, as a community, to avoid, or at least manage, that conflict. We welcome contributions from all around the LSST Science community.
 
-* **[Read the current draft of the white paper](http://www.slac.stanford.edu/~digel/ObservingStrategy/whitepaper/LSST_Observing_Strategy_White_Paper.pdf)** (automatically generated PDF, updated every hour, in principle - [log file is here](http://www.slac.stanford.edu/~digel/ObservingStrategy/whitepaper/LSST_Observing_Strategy_White_Paper.log))
+<!--
+* **[Read the current draft of the white paper](http://www.slac.stanford.edu/~digel/ObservingStrategy/whitepaper/LSST_Observing_Strategy_White_Paper.pdf)** (automatically generated PDF, updated every hour, in principle - [log file is here](http://www.slac.stanford.edu/~digel/ObservingStrategy/whitepaper/LSST_Observing_Strategy_White_Paper.log)) -->
+
+* **[Read the current draft of the white paper](https://github.com/LSSTScienceCollaborations/ObservingStrategy/blob/pdf/whitepaper/LSST_Observing_Strategy_White_Paper.pdf
+)** (automatically generated PDF, rebuilt every time the `master` branch is updated)
 [![Build Status](https://travis-ci.org/LSSTScienceCollaborations/ObservingStrategy.svg?branch=master)](https://travis-ci.org/LSSTScienceCollaborations/ObservingStrategy)
 
 * **[Join the conversation about this project at its issues list](https://github.com/LSSTScienceCollaborations/ObservingStrategy/issues)**

whitepaper/LSST_Observing_Strategy_White_Paper.tex

@@ -31,24 +31,15 @@
 
 \vspace*{\stretch{2}}
 
-% Version number, to be taken out for published draft
-\include{VersionDate}
-
-% \begin{center}
-% {\Large\bf Version 1.0\\
-%
-% \vspace*{\stretch{0.2}}
-%
-% November 2009}
-% \end{center}
-
 \vspace*{\stretch{2.5}}
 
 {\Large  Prepared by the LSST Science Collaborations,}\\
 \vspace*{\stretch{0.15}}
 {\Large with support from the LSST Project. }\\
 \vspace*{\stretch{1}}
 
+\input{thisversion.tex}
+
 \end{center}
 \end{titlepage}
 

whitepaper/Makefile

@@ -12,13 +12,16 @@ vclean: clean
 
 pdf: $(PAPER)
 
-LSST_Observing_Strategy_White_Paper.pdf: LSST_Observing_Strategy_White_Paper.tex LSST_Observing_Strategy_White_Paper.sty $(BIBFILES) $(TEXFILES)
+LSST_Observing_Strategy_White_Paper.pdf: version LSST_Observing_Strategy_White_Paper.tex LSST_Observing_Strategy_White_Paper.sty $(BIBFILES) $(TEXFILES)
 	pdflatex LSST_Observing_Strategy_White_Paper.tex
 	pdflatex LSST_Observing_Strategy_White_Paper.tex
 	bibtex   LSST_Observing_Strategy_White_Paper
 	pdflatex LSST_Observing_Strategy_White_Paper.tex
 	pdflatex LSST_Observing_Strategy_White_Paper.tex
 
+version:
+	tcsh gen_version.csh --version 0.99
+
 run: $(ARG)_standalone.tex LSST_Observing_Strategy_White_Paper.sty  $(BIBFILES) $(TEXFILES)
 	pdflatex $(ARG)_standalone.tex
 	pdflatex $(ARG)_standalone.tex

whitepaper/gen_version.csh

@@ -0,0 +1,95 @@
+#!/bin/tcsh
+#=======================================================================
+#+
+# NAME:
+#   gen_version
+#
+# PURPOSE:
+#   Find out the most recent commit ID, and write a small tex file
+#   for input into the white paper.
+#
+# COMMENTS:
+#
+# INPUTS:
+#   None
+#
+# OPTIONAL INPUTS:
+#   -h --help           Print this header
+#   -v --version        Manual version number
+#
+# OUTPUTS:
+#   version.tex         Tex file for input into white paper
+#
+# EXAMPLES:
+#
+# BUGS:
+#
+#-
+# ======================================================================
+
+set help = 0
+set version = 0.0
+
+while ( $#argv > 0 )
+   switch ($argv[1])
+   case -h:
+      shift argv
+      set help = 1
+      breaksw
+   case --{help}:
+      shift argv
+      set help = 1
+      breaksw
+   case -v:
+      shift argv
+      set version = $argv[1]
+      shift argv
+      breaksw
+   case --{version}:
+      shift argv
+      set version = $argv[1]
+      shift argv
+      breaksw
+   endsw
+end
+
+if ($help) then
+  more $0
+  goto FINISH
+endif
+
+# # Get most recent tag name:
+# set version = `git describe --tags | cut -d'-' -f1`
+# set version_url = "https://github.com/LSSTScienceCollaborations/ObservingStrategy/releases/tag/${version}"
+# Abandoning this - the problem is that when we make a new release,
+# it won't update the tags until *after we've made it, at which
+# point the PDF has already become part of the release. I think we have
+# to set the Version number by hand.
+
+# Get most recent commit ID and its date:
+set SHA = `git show | head -1 | cut -d' ' -f2`
+set short_SHA = `echo $SHA | cut -c1-7`
+set date = `git log --date=rfc | head -3 | grep Date | cut -d':' -f2-`
+
+# Get URL of latest commit:
+set commit_url = "https://github.com/LSSTScienceCollaborations/ObservingStrategy/commit/${SHA}?diff=split"
+
+# Append commit ID to version number:
+set version = "${version}.${short_SHA}"
+
+# Write tex file for input into paper:
+set texfile = "thisversion.tex"
+set template = "version.tex"
+\rm -f $texfile ; touch $texfile
+
+cat $template | \
+    sed s%XX%"${version}"%g | \
+    sed s%URL%"${commit_url}"%g | \
+    sed s%SHA%"${short_SHA}"%g | \
+    sed s%DATE%"${date}"%g > $texfile
+
+cat $texfile
+
+# ======================================================================
+FINISH:
+# ======================================================================

whitepaper/introduction.tex

@@ -458,7 +458,7 @@ \subsection{Timeline}
 project resources, these milestones should be considered as those we
 could achieve given our best effort. Likewise, given the limited
 availability of resources in the SOCS and Scheduler engineering team,
-support of community members who wish to use \OpSim v4 will be on a best
+support of community members who wish to use \OpSim~v4 will be on a best
 effort basis. \OpSim v4 will be delivered as a Docker container and its
 use and operation will be documented, but there will be no guarantee of
 support for, or timeliness in response to requests for support from,

whitepaper/version.tex

@@ -0,0 +1,7 @@
+\begin{center}{
+    {\large\bf Version XX}\\
+    \vspace*{\stretch{0.1}}
+    Most recent commit: \href{URL}{\texttt{SHA}}\\
+    \vspace*{\stretch{0.1}}
+    (DATE)}\\
+\end{center}