Skip to content

Commit

Permalink
Citation instructions (#6444)
Browse files Browse the repository at this point in the history
* [ new ] Create CITATION.cff

* Add CITATION.cff to `change-version.bash` and `test.yml` accordingly

* Exclude CITATION.cff in CI

* Change "The Agda Team" to "Agda Developers"
  • Loading branch information
L-TChen committed Mar 5, 2024
1 parent afbc1c9 commit 7ad9543
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,7 @@ name: Build, Test, and Benchmark
- '!hie*.yaml'
- '!stack-*.yaml'
- '!touchup.sh'
- '!CITATION.cff'
push:
branches:
- master
Expand Down Expand Up @@ -345,4 +346,5 @@ name: Build, Test, and Benchmark
- '!hie*.yaml'
- '!stack-*.yaml'
- '!touchup.sh'
- '!CITATION.cff'
workflow_dispatch: null
8 changes: 8 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- name: "Agda Developers"
title: "Agda"
version: 2.6.5
license-url: "https://agda.readthedocs.io/en/v2.6.5/team.html"
url: "https://agda.readthedocs.io/"
2 changes: 1 addition & 1 deletion doc/user-manual/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

project = 'Agda'
copyright = u'''2005–2024 remains with the authors.'''
author = u'The Agda Team'
author = u'Agda Developers'

# The short X.Y version
version = '2.6.5'
Expand Down
1 change: 1 addition & 0 deletions src/github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ on:
- '!hie*.yaml'
- '!stack-*.yaml'
- '!touchup.sh'
- '!CITATION.cff'

pull_request:
paths: *path_list
Expand Down
1 change: 1 addition & 0 deletions src/release-tools/change-version.bash
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ old_version="$1"
new_version="$2"

files+='Agda.cabal '
files+='CITATION.cff '
files+='doc/user-manual/conf.py '
files+='mk/versions.mk '
files+='src/data/emacs-mode/agda2-mode.el '
Expand Down

0 comments on commit 7ad9543

Please sign in to comment.