cffconvert GitHub Action

GitHub action to validate CITATION.cff files, and convert to other citation formats using dockerized version of cffconvert.

Usage

1. Save the snippet below as .github/workflows/cffconvert.yml to validate your CITATION.cff on each push.
2. git add, commit and push to your GitHub repository
3. Check the Actions tab on your repository's page to check the action's output

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: Check whether the citation metadata from CITATION.cff is valid
        uses: citation-file-format/cffconvert-github-action@2.0.0
        with:
          args: "--validate"

You can also look into advanced examples.

Developed by Netherlands eScience Center.

esciencecenter.nl