Update DOI, version, and release date in citation.cff automatically when publishing #57

Signed-off-by: Chin Yeung Li <[email protected]>

Author: chinyeungli

.github/workflows/update-citation.yml

@@ -0,0 +1,46 @@
+name: Auto-update CITATION.cff
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  update-citation:
+    runs-on: ubuntu-24.04
+
+    strategy:
+      max-parallel: 4
+      matrix:
+          python-version: [3.13]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+            python-version: ${{ matrix.python-version }}
+
+      - name: Install doi2cff
+        run:
+            pip install
+            git+https://github.com/citation-file-format/doi2cff
+
+      - name: Fetch latest Zenodo DOI
+        env:
+            ZENODO_TOKEN: ${{ secrets.ZENODO_TOKEN }}
+        run: |
+            python etc/scripts/fetch_latest_doi.py > latest_doi.txt
+            echo "Latest DOI: $(cat latest_doi.txt)"
+
+      - name: Update CITATION.cff
+        run: doi2cff update $(cat latest_doi.txt)
+
+      - name: Commit updated CITATION.cff
+        run: |
+            git config user.name "github-actions"
+            git config user.email "[email protected]"
+            git add CITATION.cff
+            git commit -m "Update CITATION.cff with latest Zenodo DOI"
+            git push origin HEAD:develop

CITATION.cff

@@ -13,6 +13,3 @@ authors:
     - name: 'nexB Inc. and others.'
 license: Apache-2.0
 url: 'https://github.com/aboutcode-org/scancode-toolkit'
-# version: <ToDo>
-# date-released: <ToDo>
-# doi: <ToDo>

etc/scripts/fetch_latest_doi.py

@@ -0,0 +1,18 @@
+import requests
+import os
+
+CONCEPT_DOI = "10.5281/zenodo.16361290"
+ZENODO_API = "https://zenodo.org/api/records"
+TOKEN = os.getenv("ZENODO_TOKEN")
+
+params = {
+    "q": f"conceptdoi:{CONCEPT_DOI}",
+    "sort": "version",
+    "size": 1,
+    "access_token": TOKEN
+}
+
+r = requests.get(ZENODO_API, params=params)
+r.raise_for_status()
+latest_record = r.json()["hits"]["hits"][0]
+print(latest_record["doi"])