{"id":16552396,"url":"https://github.com/dieghernan/cff-validator","last_synced_at":"2025-07-21T12:02:55.245Z","repository":{"id":47249772,"uuid":"401790221","full_name":"dieghernan/cff-validator","owner":"dieghernan","description":"Validate your CITATION.cff file with GitHub Actions","archived":false,"fork":false,"pushed_at":"2025-01-23T20:48:29.000Z","size":2590,"stargazers_count":12,"open_issues_count":5,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-12T04:18:22.439Z","etag":null,"topics":["cff","citation","citation-file-format","citation-files","github-actions"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/cff-validator","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dieghernan.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"dieghernan","patreon":null,"open_collective":null,"ko_fi":"dieghernan","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":null,"thanks_dev":null,"custom":null}},"created_at":"2021-08-31T17:33:37.000Z","updated_at":"2025-02-10T23:13:22.000Z","dependencies_parsed_at":"2024-02-08T07:27:35.790Z","dependency_job_id":"ae7a32df-ac05-4e06-ba3b-c4915f88fa93","html_url":"https://github.com/dieghernan/cff-validator","commit_stats":{"total_commits":114,"total_committers":5,"mean_commits":22.8,"dds":0.4649122807017544,"last_synced_commit":"0671c69555bba5936c39a49244fd2cac105ffc6a"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/dieghernan/cff-validator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dieghernan%2Fcff-validator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dieghernan%2Fcff-validator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dieghernan%2Fcff-validator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dieghernan%2Fcff-validator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dieghernan","download_url":"https://codeload.github.com/dieghernan/cff-validator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dieghernan%2Fcff-validator/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266296760,"owners_count":23907012,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-21T11:47:31.412Z","response_time":64,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cff","citation","citation-file-format","citation-files","github-actions"],"created_at":"2024-10-11T19:44:42.944Z","updated_at":"2025-07-21T12:02:55.220Z","avatar_url":"https://github.com/dieghernan.png","language":"R","funding_links":["https://github.com/sponsors/dieghernan","https://ko-fi.com/dieghernan"],"categories":[],"sub_categories":[],"readme":"# cff-validator\n\n![latest-version](https://img.shields.io/github/v/release/dieghernan/cff-validator)\n[![CITATION-cff](https://github.com/dieghernan/cff-validator/actions/workflows/cff-validator.yml/badge.svg)](https://github.com/dieghernan/cff-validator/actions/workflows/cff-validator.yml)\n[![full-test-action](https://github.com/dieghernan/cff-validator/actions/workflows/cff-validator-complete-matrix.yml/badge.svg)](https://github.com/dieghernan/cff-validator/actions/workflows/cff-validator-complete-matrix.yml)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5348443.svg)](https://doi.org/10.5281/zenodo.5348443)\n\nA GitHub action to validate `CITATION.cff` files with R.\n\n**Breaking change: v4 only works on Linux, upgrade your v3 to run on\n`ubuntu-*`.**\n\n## Introduction\n\nIf you have a [Citation File Format\n(cff)](https://citation-file-format.github.io) on your repository this action\nwould check its validity against the defined\n[schema](https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md).\n\nA full valid workflow:\n\n``` yaml\non:\n  push:\n    paths:\n      - CITATION.cff\n  workflow_dispatch:\n\nname: CITATION.cff\njobs:\n  Validate-CITATION-cff:\n    runs-on: ubuntu-latest\n    name: Validate CITATION.cff\n    env:\n      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}\n\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v4\n\n      - name: Validate CITATION.cff\n        uses: dieghernan/cff-validator@v4\n```\n\nOn error, the action produces a Job Summary with a high-level description of the\nerrors found:\n\n\u003cdetails\u003e\n\n\u003csummary\u003e\u003cstrong\u003ecitation_cff.md\u003c/strong\u003e\u003c/summary\u003e\n\n❌ CITATION.cff has errors\n\n| field           | message                          |\n|:----------------|:---------------------------------|\n| data            | has additional properties        |\n| data.authors.0  | no schemas match                 |\n| data.doi        | referenced schema does not match |\n| data.keywords.0 | is the wrong type                |\n| data.license    | referenced schema does not match |\n| data.url        | referenced schema does not match |\n\n: See [Guide to Citation File Format schema version\n1.2.0](https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md)\nfor debugging.\n\n\u003c/details\u003e\n\nFor more examples, see the actions provided on [this\npath](https://github.com/dieghernan/cff-validator/tree/main/.github/workflows).\n\n## Add a badge to your repo\n\nYou can easily create a badge showing the current status of validation of your\n`CITATION.cff` like this:\n\n[![CITATION.cff](https://github.com/dieghernan/cff-validator/actions/workflows/cff-validator.yml/badge.svg)](https://github.com/dieghernan/cff-validator/actions/workflows/cff-validator.yml)\n\n[![CITATION-cff\nerror](https://github.com/dieghernan/cff-validator/actions/workflows/cff-validator-error.yml/badge.svg)](https://github.com/dieghernan/cff-validator/actions/workflows/cff-validator-error.yml)\n\nSee a quick demo:\n\n![Demo gif showing how to create a badge for a GH action](assets/demo.gif)\n\n## Inputs available\n\n-   `citation-path`: Path to .cff file to be validated. By default it selects a\n    `CITATION.cff` file on the root of the repository:\n\n``` yaml\n  - name: Validate CITATION.cff\n    uses: dieghernan/cff-validator@v4\n    with:\n      citation-path: \"examples/CITATION.cff\"\n```\n\n-   (Soft) Deprecated parameters in **v4**:\n\n    -   `cache-version`\n\n    -   `install-r`.\n\nSee a full featured implementation on [this\nexample](https://github.com/dieghernan/cff-validator/blob/main/.github/workflows/cff-validator-complete-matrix.yml).\n\n## For useRs\n\nThis action runs on R. For the same functionality you can use the **cffr**\npackage:\n\n``` r\n\ncffr::cff_validate(\"CITATION.cff\")\n#\u003e \n#\u003e cff_validate results——\n#\u003e Congratulations! This .cff file is valid\n```\n\nSee\n[`cffr::cff_validate()`](https://docs.ropensci.org/cffr/reference/cff_validate.html)\nfor details.\n\n## References\n\nDruskat, S., Spaaks, J. H., Chue Hong, N., Haines, R., Baker, J., Bliven, S.,\nWillighagen, E., Pérez-Suárez, D., \u0026 Konovalov, A. (2021). Citation File Format\n(Version 1.2.0) [Computer software]. \u003chttps://doi.org/10.5281/zenodo.5171937\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdieghernan%2Fcff-validator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdieghernan%2Fcff-validator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdieghernan%2Fcff-validator/lists"}