Ensure version is up-to-date in references

Author: sven1103

.github/workflows/create-release.yml

@@ -8,14 +8,16 @@ on:
         required: true
 permissions:
   id-token: write # This is required for requesting the JWT
-  contents: read # This is required for actions/checkout
+  contents: write # This is required for actions/checkout
   attestations: write   # required for provenance
 jobs:
   release:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
         uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
       - name: Set up JDK 21
         uses: actions/setup-java@v5
         with:
@@ -41,6 +43,40 @@ jobs:
       - name: Set version in Maven project
         run: mvn versions:set -DnewVersion=${{ github.event.inputs.versionTag }} -DprocessAllModules
 
+      - name: Update CITATION.cff (version + date)
+        run: |
+          VERSION="${{ github.event.inputs.versionTag }}"
+          DATE="$(date -u +%Y-%m-%d)"
+          
+          # top-level fields
+          sed -i "s/^version: .*/version: \"${VERSION}\"/" CITATION.cff
+          sed -i "s/^date-released: .*/date-released: \"${DATE}\"/" CITATION.cff
+          
+          # preferred-citation fields (only if present)
+          sed -i "s/^\(\s*version:\) .*/\1 \"${VERSION}\"/" CITATION.cff
+          
+          echo "Updated CITATION.cff to version=${VERSION}, date-released=${DATE}"
+
+      - name: Commit release metadata (pom.xml + CITATION.cff)
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          
+          git add pom.xml */pom.xml CITATION.cff || true
+          
+          if git diff --cached --quiet; then
+            echo "No changes to commit."
+          else
+            git commit -m "Release ${{ github.event.inputs.versionTag }}"
+            git push
+          fi
+
+      - name: Create and push git tag
+        run: |
+          TAG="${{ github.event.inputs.versionTag }}"
+          git tag -a "${TAG}" -m "Release ${TAG}"
+          git push origin "${TAG}"
+
       - name: Build with Maven
         run: mvn -B package -Prelease --file pom.xml
 

CITATION.CFF

@@ -1,12 +1,21 @@
 cff-version: 1.2.0
 
-title: "Compass — Java library for FAIR Signposting validation of RFC 8288 Web Links (alpha)"
+title: "Compass: FAIR Signposting validation for RFC 8288 Web Links (Java, alpha)"
+
+abstract: >-
+  Compass is a Java library for validating and interpreting FAIR Signposting
+  based on RFC 8288 Web Links. It provides defensive Web Link model validation,
+  validation of FAIR Signposting Level 1 and Level 2 recipes, semantic accessors
+  for Signposting relations, and parsing support for RFC 9264 Link Sets.
+  Compass operates entirely in memory, performs no network requests, and is
+  designed to integrate with existing HTTP and metadata processing pipelines.
 
 message: >-
   This software is in an early (alpha) stage and under active development.
   APIs and behavior may change without notice.
   You may cite this version to describe the software used in your work.
-  For long-term or archival references, consider citing a later stable release when available.
+  For long-term or archival references, consider citing a later stable release
+  when available.
 
 version: "1.0.0-alpha.2"
 date-released: "2026-01-20"
@@ -23,7 +32,7 @@ license: "AGPL-3.0-only"
 
 preferred-citation:
   type: software
-  title: "Compass — Java library for FAIR Signposting validation of RFC 8288 Web Links"
+  title: "Compass: FAIR Signposting validation for RFC 8288 Web Links"
   version: "1.0.0-alpha.2"
   authors:
     - family-names: Fillinger