https://github.com/caltechlibrary/codemeta2cff
GitHub Action converting a codemeta file to CITATION.cff
https://github.com/caltechlibrary/codemeta2cff
Last synced: 3 months ago
JSON representation
GitHub Action converting a codemeta file to CITATION.cff
- Host: GitHub
- URL: https://github.com/caltechlibrary/codemeta2cff
- Owner: caltechlibrary
- License: other
- Created: 2021-07-16T18:20:13.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-04-25T23:36:58.000Z (about 1 year ago)
- Last Synced: 2026-03-15T17:08:38.708Z (3 months ago)
- Size: 111 KB
- Stars: 7
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Support: SUPPORT.md
- Codemeta: codemeta.json
Awesome Lists containing this project
README
CodeMeta2CFF
=====================================================
A GitHub action to convert a codemeta.json file to CITATION.cff. This allows
users to only have to update the CodeMeta file, but still get the benefits of
having both files in their repo.
[](https://choosealicense.com/licenses/bsd-3-clause)
[](https://github.com/caltechlibrary/codemeta2cff/releases)
[](https://doi.org/10.22002/17jew-b7x11)
Table of contents
-----------------
* [Introduction](#introduction)
* [Known issues and limitations](#known-issues-and-limitations)
* [Getting help](#getting-help)
* [License](#license)
* [Authors and history](#authors-and-history)
* [Acknowledgments](#authors-and-acknowledgments)
Introduction
------------
If you have a [CodeMeta](https://codemeta.github.io) file in your repository,
you can use this action to automatically convert it into a [Citation File Format
(cff)](https://citation-file-format.github.io) file. Add the
following to your workflow
```
- name: Convert to CFF
uses: caltechlibrary/codemeta2cff@main
```
A full workflow for updating a CFF file based on CodeMeta file changes is:
```
name: CodeMeta2CFF
run-name: Run CodeMeta2CFF after ${{github.event_name}} by ${{github.actor}}
on:
push:
paths: ['codemeta.json']
workflow_dispatch:
inputs:
reason:
description: 'Reason'
required: false
default: 'Manual trigger'
jobs:
CodeMeta2CFF:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Convert CFF
uses: caltechlibrary/codemeta2cff@main
- name: Commit CFF
uses: EndBug/add-and-commit@v9
with:
message: 'Add CITATION.cff for release'
add: 'CITATION.cff'
```
Known issues and limitations
----------------------------
Only a limited subset of CodeMeta and CFF fields have been mapped. You can
contribute by improving the codemeta2cff application at https://github.com/caltechlibrary/datatools
Getting help
------------
If you encounter any problems, please raise them in the issue tracker.
License
-------
Software produced by the Caltech Library is Copyright © 2021-2024 California Institute of Technology. This software is freely distributed under a BSD/MIT type license. Please see the [LICENSE](LICENSE) file for more information.
Authors and history
---------------------------
This action was developed by Tom Morrell, using the codemeta2cff Go application written by Robert Doiel
Acknowledgments
---------------
This work was funded by the California Institute of Technology Library.
