From a2446922500b3db4f7cec823e9401d95afc432b5 Mon Sep 17 00:00:00 2001
From: Henry Wilkinson <henry@wilkinson.graphics>
Date: Fri, 4 Apr 2025 15:23:54 -0700
Subject: [PATCH] Add a CITATION file

- Updates the `update-version.sh` script to also update the citation file with the correct version number
---
 CITATION.cff      | 25 +++++++++++++++++++++++++
 update-version.sh |  4 ++++
 2 files changed, 29 insertions(+)
 create mode 100644 CITATION.cff

diff --git a/CITATION.cff b/CITATION.cff
new file mode 100644
index 0000000000..15f6b96e82
--- /dev/null
+++ b/CITATION.cff
@@ -0,0 +1,25 @@
+cff-version: 1.2.0
+title: Browsertrix
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - name: Webrecorder Software LLC
+    country: US
+    website: 'https://webrecorder.net'
+identifiers:
+  - type: url
+    value: >-
+      https://github.com/webrecorder/browsertrix/releases/tag/v1.14.8
+    description: GitHub release
+repository-code: 'https://github.com/webrecorder/browsertrix/'
+url: 'https://webrecorder.net/browsertrix'
+keywords:
+  - kubernetes
+  - web-archiving
+  - wacz
+  - warc
+  - archives
+license: AGPL-3.0
+version: 1.14.8
diff --git a/update-version.sh b/update-version.sh
index 2a70f7edc5..483bb4a79a 100755
--- a/update-version.sh
+++ b/update-version.sh
@@ -12,3 +12,7 @@ sed -E -i "" "s/^version:.*$/version: v$version/" chart/Chart.yaml
 
 sed -E -i "" "s/\/browsertrix-backend:[[:alnum:].-]+/\/browsertrix-backend:$version/" chart/values.yaml
 sed -E -i "" "s/\/browsertrix-frontend:[[:alnum:].-]+/\/browsertrix-frontend:$version/" chart/values.yaml
+
+# Update the version & release URL in CITATION.cff
+sed -E -i "" "s/^version: [0-9]+\.[0-9]+\.[0-9]+$/version: $version/" CITATION.cff
+sed -E -i "" "s|(https://github.com/webrecorder/browsertrix/releases/tag/)v[0-9]+\.[0-9]+\.[0-9]+|\1v$version|" CITATION.cff