Skip to content

Add a CITATION.cff file #2532

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions update-version.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
Loading