Data

Tools

Indexes

Applications

Experiments

Open Source Science

caltechlibrary/codemeta2cff

GitHub Action converting a codemeta file to CITATION.cff

https://github.com/caltechlibrary/codemeta2cff

Science Score: 65.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
    Found 3 DOI reference(s) in README
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ✓
    Institutional organization owner
    Organization caltechlibrary has institutional domain (www.library.caltech.edu)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.1%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

GitHub Action converting a codemeta file to CITATION.cff

Basic Info
  • Host: GitHub
  • Owner: caltechlibrary
  • License: other
  • Default Branch: main
  • Size: 111 KB
Statistics
  • Stars: 6
  • Watchers: 4
  • Forks: 1
  • Open Issues: 0
  • Releases: 9
Created almost 5 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Support Codemeta

README.md

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.

License Latest release DOI

Table of contents

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.


Owner

  • Name: Caltech Library
  • Login: caltechlibrary
  • Kind: organization
  • Email: helpdesk@library.caltech.edu
  • Location: Pasadena, CA 91125

We manage the physical and digital holdings of the California Institute of Technology, provide services and training, and develop open-source software.

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
title: codemeta2cff
authors:
  - family-names: Morrell
    given-names: Thomas E.
    orcid: https://orcid.org/0000-0001-9266-5146
abstract: GitHub Action for converting a CodeMeta file to CITATION.cff
repository-code: "https://github.com/caltechlibrary/codemeta2cff"
type: software
doi: 10.22002/q79s0-7w020
version: 0.3.3
license-url: "https://github.com/caltechlibrary/codemeta2cff/blob/main/LICENSE"
keywords:
  - codemeta
  - software
  - cff
date-released: 2024-11-07

CodeMeta (codemeta.json) 

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "author": [
    {
      "@id": "https://orcid.org/0000-0001-9266-5146",
      "@type": "Person",
      "affiliation": {
        "@type": "Organization",
        "name": "Caltech Library"
      },
      "familyName": "Morrell",
      "givenName": "Thomas E."
    }
  ],
  "issueTracker": "https://github.com/caltechlibrary/codemeta2cff/issues",
  "license": "https://github.com/caltechlibrary/codemeta2cff/blob/main/LICENSE",
  "developmentStatus": "active",
  "downloadUrl": "https://github.com/caltechlibrary/codemeta2cff/archive/main.zip",
  "codeRepository": "https://github.com/caltechlibrary/codemeta2cff",
  "keywords": [
    "codemeta",
    "software",
    "cff"
  ],
  "name": "codemeta2cff",
  "description": "GitHub Action for converting a CodeMeta file to CITATION.cff",
  "version": "0.3.3",
  "maintainer": [
    {
      "@id": "https://orcid.org/0000-0001-9266-5146",
      "@type": "Person",
      "affiliation": {
        "@type": "Organization",
        "name": "Caltech Library"
      },
      "familyName": "Morrell",
      "givenName": "Thomas E."
    }
  ],
  "identifier": "10.22002/q79s0-7w020"
}

GitHub Events

Total
  • Create event: 4
  • Issues event: 1
  • Release event: 4
  • Push event: 27
Last Year
  • Create event: 4
  • Issues event: 1
  • Release event: 4
  • Push event: 27

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 1
  • Total pull requests: 0
  • Average time to close issues: 6 months
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: 6 months
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.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
  • tmorrell (1)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 4
  • Total versions: 9
github actions: caltechlibrary/codemeta2cff

Convert a CodeMeta file to Citation File Format (cff)

  • License: other
  • Latest release: v0.3.3
    published over 1 year ago
  • Versions: 9
  • Dependent Packages: 0
  • Dependent Repositories: 4
Rankings
Dependent packages count: 0.0%
Dependent repos count: 16.4%
Average: 18.6%
Stargazers count: 22.9%
Forks count: 35.1%
Last synced: 11 months ago

Dependencies

.github/workflows/cff-validator.yaml actions
  • actions/checkout v2 composite
  • actions/upload-artifact v2 composite
  • dieghernan/cff-validator main composite
.github/workflows/codemeta2cff.yml actions
  • EndBug/add-and-commit v7 composite
  • actions/checkout v2 composite
  • caltechlibrary/codemeta2cff main composite
.github/workflows/iga.yml actions
  • caltechlibrary/iga main composite
action.yml actions