build: version number and date in e-book

dwmkerr · Oct 1, 2020 · 0bf80bf · 0bf80bf
1 parent 50e2f2e
commit 0bf80bf
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 3 deletions.
diff --git a/.github/workflows/build-on-pull-request.yaml b/.github/workflows/build-on-pull-request.yaml
@@ -14,9 +14,14 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
 
+      # Set a descriptive version. For PRs it'll be the short sha.
+      - name: Set Version
+        id: set_version
+        run: echo ::set-output name=VERSION::$(git rev-parse --short HEAD)
+
       # Prepare the content files.
       - name: Prepare Content
-        run: ./scripts/prepare-markdown-for-ebook.sh
+        run: ./scripts/prepare-markdown-for-ebook.sh ${{ steps.set_version.outputs.VERSION }}
 
       # Create a PDF from the prepared markdown.
       - name: Prepare PDF

diff --git a/.github/workflows/release-on-tag.yaml b/.github/workflows/release-on-tag.yaml
@@ -14,9 +14,14 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
 
+      # Set a descriptive version. For PRs it'll be the short sha.
+      - name: Set Version
+        id: set_version
+        run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
+
       # Prepare the content files.
       - name: Prepare Content
-        run: ./scripts/prepare-markdown-for-ebook.sh
+        run: ./scripts/prepare-markdown-for-ebook.sh ${{ steps.set_version.outputs.VERSION }}
 
       # Create a PDF from the prepared markdown.
       - name: Prepare PDF

diff --git a/scripts/prepare-markdown-for-ebook.sh b/scripts/prepare-markdown-for-ebook.sh
@@ -2,12 +2,21 @@
 # This script prepares a `hacker-laws.md` file which is in a format ready to be
 # exported to PDF or other formats for an e-book.
 
+# Require that we provide the version number and get a date.
+version=$1
+date=$(date "+%Y-%m-%d")
+
+if [ -z $version ]; then
+    echo "version must be specified: ./prepare-markdown-for-ebook.sh <version>"
+    exit 1
+fi
+
 # Create the frontmatter.
 cat << EOF > frontmatter.md
 ---
 title: "Hacker Laws"
 author: "Dave Kerr, github.com/dwmkerr/hacker-laws"
-subtitle: "Laws, Theories, Principles and Patterns that developers will find useful."
+subtitle: "Laws, Theories, Principles and Patterns that developers will find useful. ${version}, ${date}."
 ---
 EOF