Skip to content

Commit

Permalink
adding a CITATION.cff and a GHA to check it (#123)
Browse files Browse the repository at this point in the history
* adding a CITATION.cff and a GHA to check it

* adding CITATION.cff to the manifest

* adding license url
  • Loading branch information
HGWright authored Jun 9, 2023
1 parent d66f5f4 commit bb31408
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .github/workflows/ci-citation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: ci-citation

on:
pull_request:
paths:
- "CITATION.cff"

push:
paths:
- "CITATION.cff"

workflow_dispatch:

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
validate:
name: "validate"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0

- name: "check CITATION.cff"
uses: citation-file-format/[email protected]
with:
args: "--validate"
35 changes: 35 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
cff-version: 1.2.0
message: "If Python-Stratify played an important part in your research then please add us to your reference list by using the references below."
authors:
- family-names: "Elson"
given-names: "Phil"
orcid: "https://orcid.org/0000-0001-6360-749X"
- family-names: "Little"
given-names: "Bill"
orcid: "https://orcid.org/0000-0002-1345-9465"
- family-names: "Andela"
given-names: "Bouwe"
orcid: "https://orcid.org/0000-0001-9005-8940"
- family-names: "Dreyer"
given-names: "Laura"
orcid: "https://orcid.org/0009-0006-6310-3658"
- family-names: "Fernandes"
given-names: "Filipe"
orcid: "https://orcid.org/0000-0003-4165-2913"
- family-names: "Rol"
given-names: "Evert"
orcid: "https://orcid.org/0000-0001-8357-4453"
- family-names: "Wright"
given-names: "Henry"
orcid: "https://orcid.org/0009-0005-1489-760X"
- family-names: "Yeo"
given-names: "Martin"
orcid: "https://orcid.org/0009-0000-6857-560X"
title: "python-stratify"
abstract: "Interpolation for restratification, particularly useful for Nd vertical interpolation of atmospheric and oceanographic datasets"
license: "BSD-3-Clause"
license-url: "https://spdx.org/licenses/BSD-3-Clause.html"
date-released: "2018-06-01"
doi: "10.5281/zenodo.7863857"
repository-code: "https://github.com/SciTools/python-stratify"
type: "software"
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ prune .github
prune requirements
recursive-include requirements *.txt
recursive-include src *.py *.pyx
include CITATION.cff
exclude .flake8
exclude .gitignore
exclude .pre-commit-config.yaml
Expand Down

0 comments on commit bb31408

Please sign in to comment.