dieghernan/cff-validator

Validate your CITATION.cff file with GitHub Actions

https://github.com/dieghernan/cff-validator

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 5 DOI reference(s) in README
✓
Academic publication links
Links to: zenodo.org
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (12.0%) to scientific vocabulary

Keywords

cff citation citation-file-format citation-files github-actions

Keywords from Contributors

mesh differentiable distribution cran-r ggplot-extension r-spatial rspatial rstats-package terra attribution

Last synced: 4 months ago · JSON representation ·

Repository

Validate your CITATION.cff file with GitHub Actions

Basic Info

Host: GitHub
Owner: dieghernan
License: mit
Language: R
Default Branch: main
Homepage: https://github.com/marketplace/actions/cff-validator
Size: 2.47 MB

Statistics

Stars: 13
Watchers: 2
Forks: 3
Open Issues: 5
Releases: 7

Topics

cff citation citation-file-format citation-files github-actions

Created over 4 years ago · Last pushed 11 months ago

Metadata Files

Readme Changelog Funding License Citation

cff-validator

latest-version

A GitHub action to validate CITATION.cff files with R.

Breaking change: v4 only works on Linux, upgrade your v3 to run on ubuntu-*.

Introduction

If you have a Citation File Format (cff) on your repository this action would check its validity against the defined schema.

A full valid workflow:

``` yaml on: push: paths: - CITATION.cff workflow_dispatch:

name: CITATION.cff jobs: Validate-CITATION-cff: runs-on: ubuntu-latest name: Validate CITATION.cff env: GITHUBPAT: ${{ secrets.GITHUBTOKEN }}

steps:
  - name: Checkout
    uses: actions/checkout@v4

  - name: Validate CITATION.cff
    uses: dieghernan/cff-validator@v4

```

On error, the action produces a Job Summary with a high-level description of the errors found:

citation_cff.md

❌ CITATION.cff has errors | field | message | |:----------------|:---------------------------------| | data | has additional properties | | data.authors.0 | no schemas match | | data.doi | referenced schema does not match | | data.keywords.0 | is the wrong type | | data.license | referenced schema does not match | | data.url | referenced schema does not match | : See [Guide to Citation File Format schema version 1.2.0](https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md) for debugging.

For more examples, see the actions provided on this path.

Add a badge to your repo

You can easily create a badge showing the current status of validation of your CITATION.cff like this:

See a quick demo:

Demo gif showing how to create a badge for a GH action

Inputs available

citation-path: Path to .cff file to be validated. By default it selects a CITATION.cff file on the root of the repository:

yaml - name: Validate CITATION.cff uses: dieghernan/cff-validator@v4 with: citation-path: "examples/CITATION.cff"

(Soft) Deprecated parameters in v4:
- cache-version
- install-r.

See a full featured implementation on this example.

For useRs

This action runs on R. For the same functionality you can use the cffr package:

``` r

cffr::cff_validate("CITATION.cff")

>

> cff_validate results——

> Congratulations! This .cff file is valid

```

See cffr::cff_validate() for details.

References

Druskat, S., Spaaks, J. H., Chue Hong, N., Haines, R., Baker, J., Bliven, S., Willighagen, E., Pérez-Suárez, D., & Konovalov, A. (2021). Citation File Format (Version 1.2.0) [Computer software]. https://doi.org/10.5281/zenodo.5171937

Owner

Name: Diego H.
Login: dieghernan
Kind: user
Location: Madrid, ES

Website: https://dieghernan.github.io/
Twitter: dhernangomez
Repositories: 102
Profile: https://github.com/dieghernan

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software in your research, please cite it as below."
title: "cff-validator"
version: "v4"
doi: 10.5281/zenodo.5348443
abstract: "A GitHub action to validate CITATION.cff files with R."
authors:
- family-names: "Hernangómez"
  given-names: "Diego"
  orcid: "https://orcid.org/0000-0001-8457-4658"
license: MIT
url: "https://github.com/marketplace/actions/cff-validator"
repository-code: "https://github.com/dieghernan/cff-validator"
keywords:
  - cff
  - citation
  - citation-file-format
  - citation-files
  - github-actions
references:
  - title: Citation File Format
    abstract: CITATION.cff files are plain text files with human- and machine-readable citation information for software. Code developers can include them in their repositories to let others know how to correctly cite their software. This is the specification for the Citation File Format.
    version: 1.2.0
    type: software
    authors:
      - family-names: Druskat
        given-names: Stephan
        orcid: https://orcid.org/0000-0003-4925-7248
      - family-names: Spaaks
        given-names: Jurriaan H.
        orcid: https://orcid.org/0000-0002-7064-4069
      - family-names: Chue Hong
        given-names: Neil
        orcid: https://orcid.org/0000-0002-8876-7606
      - family-names: Haines
        given-names: Robert
        orcid: https://orcid.org/0000-0002-9538-7919
      - family-names: Baker
        given-names: James
        orcid: https://orcid.org/0000-0002-2682-6922
      - family-names: Bliven
        given-names: Spencer
        orcid: https://orcid.org/0000-0002-1200-1698
        email: spencer.bliven@gmail.com
      - family-names: Willighagen
        given-names: Egon
        orcid: https://orcid.org/0000-0001-7542-0286
      - family-names: Pérez-Suárez
        given-names: David
        orcid: https://orcid.org/0000-0003-0784-6909
        website: https://dpshelio.github.io
      - family-names: Konovalov
        given-names: Alexander
        orcid: https://orcid.org/0000-0001-5299-3292
    identifiers:
      - type: doi
        value: 10.5281/zenodo.1003149
        description: The concept DOI for the collection containing all versions of the Citation File Format.
      - type: doi
        value: 10.5281/zenodo.5171937
        description: The versioned DOI for the version 1.2.0 of the Citation File Format.
    date-released: "2021-08-09"
    keywords:
      - citation file format
      - CFF
      - citation files
      - software citation
      - file format
      - YAML
      - software sustainability
      - research software
      - credit
    license: "CC-BY-4.0"
    doi: 10.5281/zenodo.5171937

GitHub Events

Total

Create event: 4
Release event: 2
Issues event: 2
Watch event: 3
Delete event: 1
Issue comment event: 4
Push event: 34
Pull request event: 3
Fork event: 1

Last Year

Create event: 4
Release event: 2
Issues event: 2
Watch event: 3
Delete event: 1
Issue comment event: 4
Push event: 34
Pull request event: 3
Fork event: 1

Committers

Last synced: 5 months ago

All Time

Total Commits: 132
Total Committers: 7
Avg Commits per committer: 18.857
Development Distribution Score (DDS): 0.053

Past Year

Commits: 10
Committers: 1
Avg Commits per committer: 10.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
dieghernan	d**o@g**m	125
dependabot[bot]	4****]	2
tbeu	t****u	1
Stephan Druskat	m**l@s**t	1
Michael Behrisch	o**s@b**e	1
Kurt McKee	c**e@k**g	1
ImgBotApp	I**p@g**m	1

Committer Domains (Top 20 + Academic)

kurtmckee.org: 1 behrisch.de: 1 sdruskat.net: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 7
Total pull requests: 13
Average time to close issues: about 20 hours
Average time to close pull requests: 1 day
Total issue authors: 6
Total pull request authors: 8
Average comments per issue: 1.86
Average comments per pull request: 1.08
Merged pull requests: 12
Bot issues: 0
Bot pull requests: 3

Past Year

Issues: 3
Pull requests: 2
Average time to close issues: N/A
Average time to close pull requests: less than a minute
Issue authors: 3
Pull request authors: 2
Average comments per issue: 0.0
Average comments per pull request: 0.0
Merged pull requests: 1
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

sdruskat (2)
Christian-B (1)
elinscott (1)
behrisch (1)
graeme-a-stewart (1)
aromanielloNTIA (1)

Pull Request Authors

dieghernan (5)
dependabot[bot] (3)
kurtmckee (2)
tbeu (2)
behrisch (1)
imgbot[bot] (1)
sdruskat (1)
graeme-a-stewart (1)

Top Labels

Issue Labels

help wanted (1)

Pull Request Labels

dependencies (3)

Packages

Total packages: 1
Total downloads: unknown
Total docker downloads: 29

Total dependent packages: 0
Total dependent repositories: 57
Total versions: 8

github actions: dieghernan/cff-validator

Validate your repository's CITATION.cff file using R software

Homepage: https://github.com/marketplace/actions/cff-validator
License: mit
Latest release: v3.0.2
published almost 2 years ago

Versions: 8
Dependent Packages: 0
Dependent Repositories: 57
Docker Downloads: 29

Rankings

Dependent packages count: 0.0%

Docker downloads count: 4.2%

Dependent repos count: 6.1%

Average: 9.2%

Stargazers count: 14.2%

Forks count: 21.7%

Last synced: 12 months ago

Dependencies

.github/workflows/cff-validator-complete-matrix.yml actions

actions/checkout v3 composite
dieghernan/cff-validator main composite

.github/workflows/cff-validator-complete.yml actions

actions/checkout v3 composite
dieghernan/cff-validator main composite

.github/workflows/cff-validator-dev.yml actions

actions/checkout v3 composite
dieghernan/cff-validator dev composite

.github/workflows/cff-validator-error.yml actions

actions/checkout v3 composite
dieghernan/cff-validator main composite

.github/workflows/cff-validator.yml actions

actions/checkout v3 composite
dieghernan/cff-validator main composite

action.yml actions

actions/cache v3 composite
r-lib/actions/setup-r v2 composite

dieghernan/cff-validator

Science Score: 67.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

cff-validator

Introduction

Add a badge to your repo

Inputs available

For useRs

>

> cff_validate results——

> Congratulations! This .cff file is valid

References

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

github actions: dieghernan/cff-validator

Rankings

Dependencies