Data

Tools

Indexes

Applications

Experiments

Open Source Science

citation-file-format/cffconvert-github-action

GitHub action to validate CITATION.cff files, and convert to other citation formats.

https://github.com/citation-file-format/cffconvert-github-action

Science Score: 44.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
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.3%) to scientific vocabulary

Keywords

action actions cff citation citation-file-format continuous-integration github-action github-actions zenodo-citation-metadata
Last synced: 4 months ago · JSON representation ·

Repository

GitHub action to validate CITATION.cff files, and convert to other citation formats.

Basic Info
  • Host: GitHub
  • Owner: citation-file-format
  • License: apache-2.0
  • Default Branch: main
  • Homepage:
  • Size: 157 KB
Statistics
  • Stars: 25
  • Watchers: 5
  • Forks: 3
  • Open Issues: 13
  • Releases: 5
Topics
action actions cff citation citation-file-format continuous-integration github-action github-actions zenodo-citation-metadata
Created over 5 years ago · Last pushed about 2 years ago
Metadata Files
Readme License Citation

README.advanced.md

Advanced examples

You can pass any arguments in the args: key that you would to the cffconvert CLI tool. This allows for some interesting usage.

The list of options is right below, and you can see some examples in the next sections. Options: -i, --infile PATH Path to the CITATION.cff input file. If this option is omitted, './CITATION.cff' is used. -o, --outfile PATH Path to the output file. -f, --format [apalike|bibtex|cff|codemeta|endnote|ris|schema.org|zenodo] Output format. -u, --url TEXT URL to the CITATION.cff input file. -h, --help Show help and exit. --show-trace Show error trace. --validate Validate the CITATION.cff file and exit. --version Print version and exit.

Validating from a subdirectory

```yaml name: cffconvert

on: push: paths: - CITATION.cff

jobs: validate: name: "validate" runs-on: ubuntu-latest steps: - name: Check out a copy of the repository uses: actions/checkout@v4

  - name: Validate a CITATION.cff from a subdirectory
    uses: citation-file-format/cffconvert-github-action@2.0.0
    with:
      args: "--infile ./tests/subdirectory/CITATION.cff --validate"

```

Converting CITATION.cff to Zenodo metadata format and pushing to the repo

```yaml name: cffconvert

on: push: paths: - CITATION.cff

jobs: convert: name: "convert" runs-on: ubuntu-latest steps: - name: Check out a copy of the repository uses: actions/checkout@v4

  - name: Convert CITATION.cff to Zenodo metadata format
    uses: citation-file-format/cffconvert-github-action@2.0.0
    with:
      args: "--infile ./CITATION.cff --format zenodo --outfile .zenodo.json"

  - name: Commit and push Zenodo metadata
    run: |
      git config --global user.name 'cffconvert GitHub Action'
      git config --global user.email 'cffconvert@users.noreply.github.com'
      git add .zenodo.json
      git commit -m "Automated update of Zenodo metadata"
      git push

```

Converting CITATION.cff to Zenodo metadata format and opening a pull request

```yaml name: cffconvert

on: push: paths: - CITATION.cff

jobs: convert: name: "convert" runs-on: ubuntu-latest steps: - name: Check out a copy of the repository uses: actions/checkout@v4

  - name: Convert CITATION.cff to Zenodo metadata format
    uses: citation-file-format/cffconvert-github-action@2.0.0
    with:
      args: "--infile ./CITATION.cff --format zenodo --outfile .zenodo.json"

  - name: Commit and create a Pull Request with the Zenodo file
    uses: peter-evans/create-pull-request@v3
    with:
      commit-message: ":robot: Update .zenodo.json"
      committer: "cffconvert GitHub Action <cffconvert@users.noreply.github.com>"
      title: "[auto] Update .zenodo.json"

```

Owner

  • Name: citation-file-format
  • Login: citation-file-format
  • Kind: organization

Citation (CITATION.cff) 

# YAML 1.2
---
authors:
  -
    family-names: Spaaks
    given-names: "Jurriaan H."
    orcid: "https://orcid.org/0000-0002-7064-4069"
  -
    family-names: Diblen
    given-names: Faruk
    orcid: "https://orcid.org/0000-0002-0989-929X"
  -
    family-names: "Soares Siqueira"
    given-names: Abel
    orcid: "https://orcid.org/0000-0003-4451-281X"
cff-version: "1.2.0"
date-released: 2022-01-24
identifiers:
  - type: doi
    value: 10.5281/zenodo.3993241
    description: "The work's conceptdoi"
license: "Apache-2.0"
message: "If you use this software, please cite it using these metadata."
title: "cffconvert GitHub Action"
version: 2.0.0
...

GitHub Events

Total
  • Watch event: 4
Last Year
  • Watch event: 4

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 193
  • Total Committers: 4
  • Avg Commits per committer: 48.25
  • Development Distribution Score (DDS): 0.166
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Jurriaan H. Spaaks j****s@e****l 161
Faruk D 1****n 23
Abel Soares Siqueira a****a@g****m 6
Sung Ho Yoon 5****2 3
Committer Domains (Top 20 + Academic)
esciencecenter.nl: 1

Issues and Pull Requests

Last synced: 5 months ago

All Time
  • Total issues: 43
  • Total pull requests: 28
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 1 day
  • Total issue authors: 8
  • Total pull request authors: 5
  • Average comments per issue: 1.74
  • Average comments per pull request: 1.07
  • Merged pull requests: 24
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • jspaaks (29)
  • abelsiqueira (5)
  • fdiblen (3)
  • sverhoeven (2)
  • maltelueken (1)
  • sim642 (1)
  • timothy22000 (1)
  • kevinmatthes (1)
Pull Request Authors
  • jspaaks (15)
  • abelsiqueira (6)
  • fdiblen (5)
  • cwmeijer (1)
  • syoon2 (1)
Top Labels
Issue Labels
blocked (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total docker downloads: 36
  • Total dependent packages: 0
  • Total dependent repositories: 521
  • Total versions: 5
github actions: citation-file-format/cffconvert-github-action

Validate CITATION.cff files, and convert to other citation formats.

  • License: apache-2.0
  • Latest release: 2.0.0
    published almost 4 years ago
  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 521
  • Docker Downloads: 36
Rankings
Dependent packages count: 0.0%
Dependent repos count: 1.5%
Docker downloads count: 4.0%
Average: 6.9%
Stargazers count: 7.4%
Forks count: 21.7%
Last synced: 4 months ago

Dependencies

.github/workflows/cffconvert.yml actions
  • actions/checkout v2 composite
  • citation-file-format/cffconvert-github-action 2.0.0 composite
.github/workflows/fair-software.yml actions
  • fair-software/howfairis-github-action 0.2.1 composite
.github/workflows/link-check.yml actions
  • actions/checkout main composite
  • gaurav-nelson/github-action-markdown-link-check v1 composite
.github/workflows/selftest.yml actions
  • ./ * composite
  • actions/checkout v2 composite
action.yml actions
  • docker://citationcff/cffconvert 2.0.0 docker