InvenioRDM GitHub Archiver

InvenioRDM is used by many institutional repositories such as CaltechDATA to let users preserve software and data in a long-term archive managed by their institution. Depositing software and/or data into these repositories requires the creation of detailed metadata records – a tedious and error-prone process if done manually. This is where the InvenioRDM GitHub Archiver (IGA) comes in.

IGA can create metadata records and send releases from GitHub to an InvenioRDM-based repository server. It can be run as a command line program; it also can be set up as a GitHub Action to archive GitHub releases in InvenioRDM automatically each time they are made.

➜

IGA sends metadata and assets from GitHub to an InvenioRDM server.

Sections

• Introduction
  • IGA features
  • GitHub releases
  • CodeMeta & CITATION.cff
  • Using IGA
• Installation
  • IGA as a normal program
  • IGA as a GitHub workflow
• Quick start
  • Getting an InvenioRDM token
  • Configuring IGA for local use
  • Configuring a GitHub Action
• Usage (command-line)
  • InvenioRDM server
  • InvenioRDM access token
  • GitHub access token
  • GitHub release
  • Metadata sources
  • File assets
  • InvenioRDM communities
  • Draft vs. published records
  • Record versions
  • Other options
  • Command-line summary
  • Return values
• Usage (GitHub Action)
  • Manual invocation
  • Trigger condition(s)
  • Input parameters
  • Status and notifications
• Getting the most out of IGA
  • Use CodeMeta or CFF files?
  • Which is more important?
  • How can you create them?
  • How are they used by IGA?
  • What if you have neither?
  • What if IGA misses things?
  • What are versions for?
• Glossary
• Colophon
• Appendix
  • Record metadata
  • Known limitations