Add citation.cff and note for citing in README

.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

@@ -0,0 +1,15 @@
+cff-version: 1.2.0
+message: If you use this software, please cite it using these metadata.
+title: ScanCode-Toolkit
+authors:
+    - family-names: Philippe
+      given-names: Ombredanne
+      orcid: 'https://orcid.org/0000-0001-5280-9256'
+    - family-names: Ayan
+      given-names: Sinha Mahapatra
+      orcid: 'https://orcid.org/0009-0006-0174-5727'
+    - family-names: Jono
+      given-names: Yang
+    - name: 'nexB Inc. and others.'
+license: Apache-2.0
+url: 'https://github.com/aboutcode-org/scancode-toolkit'

README.rst

@@ -134,6 +134,9 @@ Other Important Documentation Pages:
 
 See also https://aboutcode.org for related companion projects and tools.
 
+To cite this repository, visit the main page and click on the 'Cite this
+repository' button for APA or BibTeX citation formats.
+
 
 Installation
 ============

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"])