Tag user guide with version (#995)

Add the version number to the PDF user guide content and filename. Closes #895
ctc-oss · Jan 22, 2024 · 592e92f · 592e92f
1 parent 34c3086
commit 592e92f
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/.github/workflows/pdf.yml b/.github/workflows/pdf.yml
@@ -28,9 +28,18 @@ jobs:
         run: |
           git clone --depth 1 --branch ${{ steps.tag_name.outputs.VERSION }} https://github.com/ctc-oss/fapolicy-analyzer.wiki
 
+      - name: append version number
+        run: |
+          echo "" >> User-Guide.md
+          echo "---" >> User-Guide.md
+          echo "File Access Policy Analyzer version ${{ steps.tag_name.outputs.VERSION }}" >> User-Guide.md
+        working-directory: fapolicy-analyzer.wiki
+
       - name: generate pdf
         run: |
-          pandoc -V CJKmainfont="KaiTi" User-Guide.md -o fapolicy-analyzer-user-guide.pdf
+          tag=${{ steps.tag_name.outputs.VERSION }}
+          tag_version="${tag#v}"
+          pandoc -V CJKmainfont="KaiTi" User-Guide.md -o fapolicy-analyzer-user-guide-${tag_version}.pdf
         working-directory: fapolicy-analyzer.wiki
 
       - name: release
@@ -40,4 +49,4 @@ jobs:
           prerelease: ${{ startsWith(github.ref, 'refs/tags/v0') || contains(github.ref, 'rc') }}
           draft: true
           files: |
-            fapolicy-analyzer.wiki/fapolicy-analyzer-user-guide.pdf
+            fapolicy-analyzer.wiki/fapolicy-analyzer-user-guide-*.pdf
diff --git a/news/995.packaging.md b/news/995.packaging.md
@@ -0,0 +1 @@
+Add a version number to the PDF user guide content and filename.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Add a version number to the PDF user guide content and filename.