docs: Add CITATION.cff and update its version and date during release

Author: dannyadair

.github/workflows/semantic-release.yaml

@@ -56,6 +56,9 @@ jobs:
             echo "released=false" >> $GITHUB_OUTPUT
           fi
 
+      - name: Update CITATION.cff date-released
+        run: python update_citation_date.py
+
       - name: Publish package distributions to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         if: steps.release.outputs.released == 'true'

CITATION.cff

@@ -0,0 +1,17 @@
+cff-version: 1.2.0
+message: "If you use pdfbaker in your work, please cite it using the following metadata."
+title: "pdfbaker"
+version: "0.8.7"
+date-released: 2024-04-23
+repository-code: "https://github.com/pythonnz/pdfbaker"
+license: "MIT"
+authors:
+  - family-names: Adair
+    given-names: Danny
+    orcid: "https://orcid.org/0009-0004-8327-955X"
+keywords:
+  - PDF
+  - SVG
+  - YAML
+  - CLI
+  - Python

pyproject.toml

@@ -68,6 +68,7 @@ score = "no"
 
 [tool.semantic_release]
 version_toml = ["pyproject.toml:project.version"]
+version_variables = ["CITATION.cff:version"]
 branch = "main"
 build_command = "uv build"
 tag_format = "{version}"

update_citation_date.py

@@ -0,0 +1,16 @@
+"""Set the date-released field in CITATION.cff to today."""
+
+from datetime import date
+
+CITATION_FILE = "CITATION.cff"
+
+lines = []
+with open(CITATION_FILE, encoding="utf-8") as f:
+    for line in f:
+        if line.startswith("date-released:"):
+            lines.append(f"date-released: {date.today()}\n")
+        else:
+            lines.append(line)
+
+with open(CITATION_FILE, "w", encoding="utf-8") as f:
+    f.writelines(lines)