Use git versioning for guide (#67)

Also, fix a minor issue where from PR's, the git tags are not available so we can't number the doc properly.

Author: chrisfenner

.github/workflows/docker-publish.yml

@@ -22,7 +22,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4.1.1
 
       # Set up QEMU for cross-platform builds below
       - name: Set up QEMU
@@ -92,11 +92,15 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/[email protected]
+        with:
+          fetch-depth: 0
+          fetch-tags: true
 
       - name: Run the action on guide
         uses: trustedcomputinggroup/markdown@latest
         with:
+          extra-build-options: "--gitversion"
           input-md: guide.md
           output-pdf: guide.pdf
           output-tex: guide.tex

build.sh

@@ -149,6 +149,7 @@ if test "${do_gitversion}" == "yes"; then
 
 	# TODO: Should we fail if dirty?
 	raw_version="$(git describe --always --tags)"
+	echo "Git version: ${raw_version}"
 	IFS='-' read -r -a dash_hunks <<< "${raw_version}"
 
     # Could be one of:
@@ -262,11 +263,21 @@ sed 's/^---$/\\newpage/g;1s/\\newpage/---/g' "${build_dir}/${input_file}.1" > "$
 # While we're doing this, transform the case to all-caps.
 sed '0,/\\tableofcontents/s/^# \(.*\)/\\section*\{\U\1\}/g' "${build_dir}/${input_file}.2" > "${build_dir}/${input_file}.3"
 
-# Grab the date from the front matter and generate the full date and year.
-DATE="$(grep date: "${input_file}" | head -n 1 | cut -d ' ' -f 2)"
+if test "${do_gitversion}" == "yes"; then
+	# If using the git information for versioning, grab the date from there
+	DATE="$(git show -s --date=format:'%Y/%m/%d' --format=%ad)"
+else
+	# Else, grab the date from the front matter and generate the full date and year.
+	DATE="$(grep date: "${input_file}" | head -n 1 | cut -d ' ' -f 2)"
+fi
+
 YEAR="$(date --date="${DATE}" +%Y)"
 DATE_ENGLISH="$(date --date="${DATE}" "+%B %-d, %Y")"
 
+echo "Date: ${DATE}"
+echo "Year: ${YEAR}"
+echo "Date (English): ${DATE_ENGLISH}"
+
 # Run Pandoc
 export MERMAID_FILTER_THEME="forest"
 export MERMAID_FILTER_FORMAT="pdf"
@@ -292,6 +303,7 @@ if [ -n "${pdf_output}" ]; then
 		--top-level-division=section \
 		--variable=block-headings \
 		--variable=numbersections \
+		--metadata=date:"${DATE}" \
 		--metadata=date-english:"${DATE_ENGLISH}" \
 		--metadata=year:"${YEAR}" \
 		--metadata=titlepage:true \

guide.md

@@ -1,10 +1,5 @@
 ---
 title: "TCG Markdown User's Guide"
-version: 0.1
-revision: 1
-date-english: December 17, 2023
-date: 2023/12/17
-year: 2023
 type: GUIDANCE
 status: DRAFT
 template: bluetop