CINXE.COM
InvenioRDM GitHub Archiver — IGA
<!DOCTYPE html> <html lang="en" data-content_root="./"> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width,initial-scale=1"> <meta http-equiv="x-ua-compatible" content="ie=edge"> <meta name="lang:clipboard.copy" content="Copy to clipboard"> <meta name="lang:clipboard.copied" content="Copied to clipboard"> <meta name="lang:search.language" content="en"> <meta name="lang:search.pipeline.stopwords" content="True"> <meta name="lang:search.pipeline.trimmer" content="True"> <meta name="lang:search.result.none" content="No matching documents"> <meta name="lang:search.result.one" content="1 matching document"> <meta name="lang:search.result.other" content="# matching documents"> <meta name="lang:search.tokenizer" content="[\s\-]+"> <link href="https://fonts.gstatic.com/" rel="preconnect" crossorigin> <link href="https://fonts.googleapis.com/css?family=Roboto+Mono:400,500,700|Roboto:300,400,400i,700&display=fallback" rel="stylesheet"> <style> body, input { font-family: "Roboto", "Helvetica Neue", Helvetica, Arial, sans-serif } code, kbd, pre { font-family: "Roboto Mono", "Courier New", Courier, monospace } </style> <link rel="stylesheet" href="_static/stylesheets/application.css"/> <link rel="stylesheet" href="_static/stylesheets/application-palette.css"/> <link rel="stylesheet" href="_static/stylesheets/application-fixes.css"/> <link rel="stylesheet" href="_static/fonts/material-icons.css"/> <meta name="theme-color" content="blue-grey"> <script src="_static/javascripts/modernizr.js"></script> <title>InvenioRDM GitHub Archiver — IGA</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=83e35b93" /> <link rel="stylesheet" type="text/css" href="_static/material.css?v=79c92029" /> <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=3e432fdf" /> <script src="_static/documentation_options.js?v=5929fcd5"></script> <script src="_static/doctools.js?v=9bcbadda"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <link rel="icon" href="_static/favicon.ico"/> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="Introduction" href="introduction.html" /> </head> <body dir=ltr data-md-color-primary=deep-orange data-md-color-accent=teal> <svg class="md-svg"> <defs data-children-count="0"> <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="__github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg> </defs> </svg> <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer"> <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search"> <label class="md-overlay" data-md-component="overlay" for="__drawer"></label> <a href="#index" tabindex="1" class="md-skip"> Skip to content </a> <header class="md-header" data-md-component="header"> <nav class="md-header-nav md-grid"> <div class="md-flex navheader"> <div class="md-flex__cell md-flex__cell--shrink"> <a href="#" title="IGA" class="md-header-nav__button md-logo"> </a> </div> <div class="md-flex__cell md-flex__cell--shrink"> <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label> </div> <div class="md-flex__cell md-flex__cell--stretch"> <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title"> <span class="md-header-nav__topic">InvenioRDM GitHub Archiver</span> <span class="md-header-nav__topic"> InvenioRDM GitHub Archiver </span> </div> </div> <div class="md-flex__cell md-flex__cell--shrink"> <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label> <div class="md-search" data-md-component="search" role="dialog"> <label class="md-search__overlay" for="__search"></label> <div class="md-search__inner" role="search"> <form class="md-search__form" action="search.html" method="get" name="search"> <input type="text" class="md-search__input" name="q" placeholder=""Search"" autocapitalize="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active"> <label class="md-icon md-search__icon" for="__search"></label> <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">  </button> </form> <div class="md-search__output"> <div class="md-search__scrollwrap" data-md-scrollfix> <div class="md-search-result" data-md-component="result"> <div class="md-search-result__meta"> Type to start searching </div> <ol class="md-search-result__list"></ol> </div> </div> </div> </div> </div> </div> <div class="md-flex__cell md-flex__cell--shrink"> <div class="md-header-nav__source"> <a href="https://github.com/caltechlibrary/iga/" title="Go to repository" class="md-source" data-md-source="github"> <div class="md-source__icon"> <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 24 24" width="28" height="28"> <use xlink:href="#__github" width="24" height="24"></use> </svg> </div> <div class="md-source__repository"> iga </div> </a> </div> </div> </div> </nav> </header> <div class="md-container"> <nav class="md-tabs" data-md-component="tabs"> <div class="md-tabs__inner md-grid"> <ul class="md-tabs__list"> <li class="md-tabs__item"><a href="#" class="md-tabs__link">Home</a></li> </ul> </div> </nav> <main class="md-main"> <div class="md-main__inner md-grid" data-md-component="container"> <div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <nav class="md-nav md-nav--primary" data-md-level="0"> <label class="md-nav__title md-nav__title--site" for="__drawer"> <a href="#" title="IGA" class="md-nav__button md-logo"> <img src="_static/" alt=" logo" width="48" height="48"> </a> <a href="#" title="IGA">InvenioRDM GitHub Archiver</a> </label> <div class="md-nav__source"> <a href="https://github.com/caltechlibrary/iga/" title="Go to repository" class="md-source" data-md-source="github"> <div class="md-source__icon"> <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 24 24" width="28" height="28"> <use xlink:href="#__github" width="24" height="24"></use> </svg> </div> <div class="md-source__repository"> iga </div> </a> </div> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="introduction.html" class="md-nav__link">Introduction</a> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="introduction.html#iga-features" class="md-nav__link">IGA features</a> </li> <li class="md-nav__item"> <a href="introduction.html#github-releases" class="md-nav__link">GitHub releases</a> </li> <li class="md-nav__item"> <a href="introduction.html#codemeta-citation-cff" class="md-nav__link">CodeMeta & CITATION.cff</a> </li> <li class="md-nav__item"> <a href="introduction.html#using-iga" class="md-nav__link">Using IGA</a> </li></ul> </li> <li class="md-nav__item"> <a href="installation.html" class="md-nav__link">Installation</a> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="installation.html#iga-as-a-normal-program" class="md-nav__link">IGA as a normal program</a> </li> <li class="md-nav__item"> <a href="installation.html#iga-as-a-github-workflow" class="md-nav__link">IGA as a GitHub workflow</a> </li></ul> </li> <li class="md-nav__item"> <a href="quick-start.html" class="md-nav__link">Quick start</a> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="quick-start.html#getting-an-inveniordm-token" class="md-nav__link">Getting an InvenioRDM token</a> </li> <li class="md-nav__item"> <a href="quick-start.html#configuring-iga-for-local-use" class="md-nav__link">Configuring IGA for local use</a> </li> <li class="md-nav__item"> <a href="quick-start.html#configuring-a-github-action" class="md-nav__link">Configuring a GitHub Action</a> </li></ul> </li> <li class="md-nav__item"> <a href="cli-usage.html" class="md-nav__link">Usage (command-line)</a> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="cli-usage.html#inveniordm-server" class="md-nav__link">InvenioRDM server</a> </li> <li class="md-nav__item"> <a href="cli-usage.html#inveniordm-access-token" class="md-nav__link">InvenioRDM access token</a> </li> <li class="md-nav__item"> <a href="cli-usage.html#github-access-token" class="md-nav__link">GitHub access token</a> </li> <li class="md-nav__item"> <a href="cli-usage.html#github-release" class="md-nav__link">GitHub release</a> </li> <li class="md-nav__item"> <a href="cli-usage.html#metadata-sources" class="md-nav__link">Metadata sources</a> </li> <li class="md-nav__item"> <a href="cli-usage.html#file-assets" class="md-nav__link">File assets</a> </li> <li class="md-nav__item"> <a href="cli-usage.html#inveniordm-communities" class="md-nav__link">InvenioRDM communities</a> </li> <li class="md-nav__item"> <a href="cli-usage.html#draft-vs-published-records" class="md-nav__link">Draft vs. published records</a> </li> <li class="md-nav__item"> <a href="cli-usage.html#record-versions" class="md-nav__link">Record versions</a> </li> <li class="md-nav__item"> <a href="cli-usage.html#other-options" class="md-nav__link">Other options</a> </li> <li class="md-nav__item"> <a href="cli-usage.html#command-line-summary" class="md-nav__link">Command-line summary</a> </li> <li class="md-nav__item"> <a href="cli-usage.html#return-values" class="md-nav__link">Return values</a> </li></ul> </li> <li class="md-nav__item"> <a href="gha-usage.html" class="md-nav__link">Usage (GitHub Action)</a> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="gha-usage.html#manual-invocation" class="md-nav__link">Manual invocation</a> </li> <li class="md-nav__item"> <a href="gha-usage.html#trigger-condition-s" class="md-nav__link">Trigger condition(s)</a> </li> <li class="md-nav__item"> <a href="gha-usage.html#input-parameters" class="md-nav__link">Input parameters</a> </li> <li class="md-nav__item"> <a href="gha-usage.html#status-and-notifications" class="md-nav__link">Status and notifications</a> </li></ul> </li> <li class="md-nav__item"> <a href="tips.html" class="md-nav__link">Getting the most out of IGA</a> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="tips.html#use-codemeta-or-cff-files" class="md-nav__link">Use CodeMeta or CFF files?</a> </li> <li class="md-nav__item"> <a href="tips.html#which-is-more-important" class="md-nav__link">Which is more important?</a> </li> <li class="md-nav__item"> <a href="tips.html#how-can-you-create-them" class="md-nav__link">How can you create them?</a> </li> <li class="md-nav__item"> <a href="tips.html#how-are-they-used-by-iga" class="md-nav__link">How are they used by IGA?</a> </li> <li class="md-nav__item"> <a href="tips.html#what-if-you-have-neither" class="md-nav__link">What if you have neither?</a> </li> <li class="md-nav__item"> <a href="tips.html#what-if-iga-misses-things" class="md-nav__link">What if IGA misses things?</a> </li> <li class="md-nav__item"> <a href="tips.html#what-are-versions-for" class="md-nav__link">What are versions for?</a> </li></ul> </li> <li class="md-nav__item"> <a href="glossary.html" class="md-nav__link">Glossary</a> </li> <li class="md-nav__item"> <a href="colophon.html" class="md-nav__link">Colophon</a> </li> <li class="md-nav__item"> <a href="appendix.html" class="md-nav__link">Appendix</a> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="appendix.html#record-metadata" class="md-nav__link">Record metadata</a> </li> <li class="md-nav__item"> <a href="appendix.html#known-limitations" class="md-nav__link">Known limitations</a> </li></ul> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <nav class="md-nav md-nav--secondary"> <ul class="md-nav__list" data-md-scrollfix=""> </ul> </nav> </div> </div> </div> <div class="md-content"> <article class="md-content__inner md-typeset" role="main"> <section id="inveniordm-github-archiver"> <h1 id="index--page-root">InvenioRDM GitHub Archiver<a class="reference internal" href="#index--page-root"><img alt="_images/cloud-upload.svg" class="align-right" src="_images/cloud-upload.svg" style="width: 10%;"/></a><a class="headerlink" href="#index--page-root" title="Link to this heading">¶</a></h1> <p><a class="reference external" href="https://inveniosoftware.org/products/rdm/">InvenioRDM</a> is used by many institutional repositories such as <a class="reference external" href="https://data.caltech.edu">CaltechDATA</a> 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 <a class="reference external" href="https://github.com/caltechlibrary/iga"><em>InvenioRDM GitHub Archiver</em></a> (IGA) comes in.</p> <p>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 <a class="reference external" href="https://docs.github.com/en/actions">GitHub Action</a> to archive GitHub releases in InvenioRDM automatically each time they are made.</p> <figure> <img align="middle" src="_static/media/example-github-release.jpg" width="40%"/> <span style="font-size: 150%">➜</span> <img align="middle" src="_static/media/example-record-landing-page.jpg" width="40%"/> <figcaption>IGA sends metadata and assets from GitHub to an InvenioRDM server.</figcaption> </figure> <section id="sections"> <h2 id="sections">Sections<a class="headerlink" href="#sections" title="Link to this heading">¶</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a><ul> <li class="toctree-l2"><a class="reference internal" href="introduction.html#iga-features">IGA features</a></li> <li class="toctree-l2"><a class="reference internal" href="introduction.html#github-releases">GitHub releases</a></li> <li class="toctree-l2"><a class="reference internal" href="introduction.html#codemeta-citation-cff">CodeMeta & CITATION.cff</a></li> <li class="toctree-l2"><a class="reference internal" href="introduction.html#using-iga">Using IGA</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul> <li class="toctree-l2"><a class="reference internal" href="installation.html#iga-as-a-normal-program">IGA as a normal program</a></li> <li class="toctree-l2"><a class="reference internal" href="installation.html#iga-as-a-github-workflow">IGA as a GitHub workflow</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="quick-start.html">Quick start</a><ul> <li class="toctree-l2"><a class="reference internal" href="quick-start.html#getting-an-inveniordm-token">Getting an InvenioRDM token</a></li> <li class="toctree-l2"><a class="reference internal" href="quick-start.html#configuring-iga-for-local-use">Configuring IGA for local use</a></li> <li class="toctree-l2"><a class="reference internal" href="quick-start.html#configuring-a-github-action">Configuring a GitHub Action</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="cli-usage.html">Usage (command-line)</a><ul> <li class="toctree-l2"><a class="reference internal" href="cli-usage.html#inveniordm-server">InvenioRDM server</a></li> <li class="toctree-l2"><a class="reference internal" href="cli-usage.html#inveniordm-access-token">InvenioRDM access token</a></li> <li class="toctree-l2"><a class="reference internal" href="cli-usage.html#github-access-token">GitHub access token</a></li> <li class="toctree-l2"><a class="reference internal" href="cli-usage.html#github-release">GitHub release</a></li> <li class="toctree-l2"><a class="reference internal" href="cli-usage.html#metadata-sources">Metadata sources</a></li> <li class="toctree-l2"><a class="reference internal" href="cli-usage.html#file-assets">File assets</a></li> <li class="toctree-l2"><a class="reference internal" href="cli-usage.html#inveniordm-communities">InvenioRDM communities</a></li> <li class="toctree-l2"><a class="reference internal" href="cli-usage.html#draft-vs-published-records">Draft vs. published records</a></li> <li class="toctree-l2"><a class="reference internal" href="cli-usage.html#record-versions">Record versions</a></li> <li class="toctree-l2"><a class="reference internal" href="cli-usage.html#other-options">Other options</a></li> <li class="toctree-l2"><a class="reference internal" href="cli-usage.html#command-line-summary">Command-line summary</a></li> <li class="toctree-l2"><a class="reference internal" href="cli-usage.html#return-values">Return values</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="gha-usage.html">Usage (GitHub Action)</a><ul> <li class="toctree-l2"><a class="reference internal" href="gha-usage.html#manual-invocation">Manual invocation</a></li> <li class="toctree-l2"><a class="reference internal" href="gha-usage.html#trigger-condition-s">Trigger condition(s)</a></li> <li class="toctree-l2"><a class="reference internal" href="gha-usage.html#input-parameters">Input parameters</a></li> <li class="toctree-l2"><a class="reference internal" href="gha-usage.html#status-and-notifications">Status and notifications</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="tips.html">Getting the most out of IGA</a><ul> <li class="toctree-l2"><a class="reference internal" href="tips.html#use-codemeta-or-cff-files">Use CodeMeta or CFF files?</a></li> <li class="toctree-l2"><a class="reference internal" href="tips.html#which-is-more-important">Which is more important?</a></li> <li class="toctree-l2"><a class="reference internal" href="tips.html#how-can-you-create-them">How can you create them?</a></li> <li class="toctree-l2"><a class="reference internal" href="tips.html#how-are-they-used-by-iga">How are they used by IGA?</a></li> <li class="toctree-l2"><a class="reference internal" href="tips.html#what-if-you-have-neither">What if you have neither?</a></li> <li class="toctree-l2"><a class="reference internal" href="tips.html#what-if-iga-misses-things">What if IGA misses things?</a></li> <li class="toctree-l2"><a class="reference internal" href="tips.html#what-are-versions-for">What are versions for?</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li> <li class="toctree-l1"><a class="reference internal" href="colophon.html">Colophon</a></li> <li class="toctree-l1"><a class="reference internal" href="appendix.html">Appendix</a><ul> <li class="toctree-l2"><a class="reference internal" href="appendix.html#record-metadata">Record metadata</a></li> <li class="toctree-l2"><a class="reference internal" href="appendix.html#known-limitations">Known limitations</a></li> </ul> </li> </ul> </div> </section> </section> </article> </div> </div> </main> </div> <footer class="md-footer"> <div class="md-footer-nav"> <nav class="md-footer-nav__inner md-grid"> <a href="introduction.html" title="Introduction" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"><span class="md-flex__ellipsis"> <span class="md-footer-nav__direction"> "Next" </span> Introduction </span> </div> <div class="md-flex__cell md-flex__cell--shrink"><i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> </div> </a> </nav> </div> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class="md-footer-copyright"> <div class="md-footer-copyright__highlight"> © Copyright 2023-2024, Caltech Library. </div> Last updated on Nov 07, 2024. <br/> Created using <a href="http://www.sphinx-doc.org/">Sphinx</a> 8.1.3. and <a href="https://github.com/bashtage/sphinx-material/">Material for Sphinx</a> </div> </div> </div> </footer> <script src="_static/javascripts/application.js"></script> <script>app.initialize({version: "1.0.4", url: {base: ".."}})</script> </body> </html>