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.

Table of contents

• Introduction
• Known issues and limitations
• Getting help
• License
• Authors and history
• Acknowledgments

Introduction

If you have a CodeMeta file in your repository, you can use this action to automatically convert it into a Citation File Format (cff) 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 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.

<div align="center"> <br> <a href="https://www.caltech.edu"> <img width="100" height="100" src="https://raw.githubusercontent.com/caltechlibrary/template/main/.graphics/caltech-round.png"> </a> </div>