Skip to content

Commit e7734ea

Browse files
Add a GitHub Actions workflow for automatic validation of the citation metadata file (CITATION.CFF) (#44062)
Hello! We noticed that your `CITATION.cff` had a small issue and fixed it. In addition to the fix, this Pull Request automates validation of that file using the [cffconvert GitHub Action](https://github.com/marketplace/actions/cffconvert). That way, it's a little bit easier to be robust against future changes to the `CITATION.cff` file. BTW it's perfectly fine if you don't feel like accepting this Pull Request for whatever reason -- we just thought it might be helpful is all. We found your repository using a partially automated workflow; if you have any questions about that, feel free to create an issue over at https://github.com/cffbots/filtering/issues/ On behalf of the cffbots team, @abelsiqueira / @fdiblen / @jspaaks --------- Co-authored-by: Max Horn <[email protected]>
1 parent a586d3c commit e7734ea

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

.github/workflows/cffconvert.yml

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: cffconvert
2+
3+
on:
4+
push:
5+
branches:
6+
- 'master'
7+
- 'release-*'
8+
paths:
9+
- CITATION.cff
10+
pull_request:
11+
branches:
12+
- 'master'
13+
- 'release-*'
14+
paths:
15+
- CITATION.cff
16+
17+
permissions:
18+
contents: read
19+
20+
jobs:
21+
validate:
22+
name: "validate"
23+
runs-on: ubuntu-latest
24+
steps:
25+
- name: Check out a copy of the repository
26+
uses: actions/checkout@v4
27+
with:
28+
persist-credentials: false
29+
30+
- name: Check whether the citation metadata from CITATION.cff is valid
31+
uses: citation-file-format/[email protected]
32+
with:
33+
args: "--validate"

CITATION.cff

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# Official format description at https://citation-file-format.github.io
12
cff-version: 1.2.0
23
message: "Cite this paper whenever you use Julia"
34
authors:

0 commit comments

Comments
 (0)