version: include version in produced docs

Fixes #398

Signed-off-by: Vincent Batts <[email protected]>

Author: vbatts

.gitignore

@@ -1,2 +1,3 @@
 output
 schema/validate
+version.md

.tool/version-doc.go

@@ -0,0 +1,25 @@
+// +build ignore
+
+package main
+
+import (
+	"fmt"
+	"html/template"
+	"os"
+
+	"github.com/opencontainers/runtime-spec/specs-go"
+)
+
+var markdownTemplateString = `
+
+**Specification Version:** *{{.}}*
+
+`
+
+var markdownTemplate = template.Must(template.New("markdown").Parse(markdownTemplateString))
+
+func main() {
+	if err := markdownTemplate.Execute(os.Stdout, specs.Version); err != nil {
+		fmt.Fprintln(os.Stderr, err)
+	}
+}

Makefile

@@ -2,6 +2,7 @@
 DOCKER ?= $(shell which docker)
 # These docs are in an order that determines how they show up in the PDF/HTML docs.
 DOC_FILES := \
+	version.md \
 	README.md \
 	code-of-conduct.md \
 	principles.md \
@@ -20,7 +21,7 @@ EPOCH_TEST_COMMIT := 041eb73d2e0391463894c04c8ac938036143eba3
 docs: pdf html
 .PHONY: docs
 
-pdf:
+pdf: $(DOC_FILES)
 	@mkdir -p output/ && \
 	$(DOCKER) run \
 	-it \
@@ -31,7 +32,7 @@ pdf:
 	vbatts/pandoc -f markdown_github -t latex -o /output/docs.pdf $(patsubst %,/input/%,$(DOC_FILES)) && \
 	ls -sh $(shell readlink -f output/docs.pdf)
 
-html:
+html: $(DOC_FILES)
 	@mkdir -p output/ && \
 	$(DOCKER) run \
 	-it \
@@ -43,6 +44,9 @@ html:
 	ls -sh $(shell readlink -f output/docs.html)
 
 
+version.md: ./specs-go/version.go
+	go run ./.tool/version-doc.go > $@
+
 HOST_GOLANG_VERSION	= $(shell go version | cut -d ' ' -f3 | cut -c 3-)
 # this variable is used like a function. First arg is the minimum version, Second arg is the version to be checked.
 ALLOWED_GO_VERSION	= $(shell test '$(shell /bin/echo -e "$(1)\n$(2)" | sort -V | head -n1)' == '$(1)' && echo 'true')