CINXE.COM
Zenodo FAQ - How does a CITATION.cff file affect metadata of my GitHub release?
<!DOCTYPE HTML> <html lang="en-gb" dir="ltr" adir="ltr" data-id='1' data-iconset='FontAwesome' data-available-locales='en-gb' data-base-path='/help/%7Blocale%7D' data-primary-locale="en-gb"> <meta charset="utf-8"> <title>Zenodo FAQ - How does a CITATION.cff file affect metadata of my GitHub release?</title> <meta name="viewport" content="width=device-width,initial-scale=1.0,viewport-fit=cover"> <link rel="stylesheet" href="/assets/knowledge_base-6b013d1dfc27439c7fdd33439e5f839d68cef24685c6e4bfe713f7fd3faf73c7.css" media="all" /> <style> html { direction: ltr } @font-face { font-family: 'FontAwesome'; src: url('/assets/icon-fonts/FontAwesome.woff'); font-weight: normal; font-style: normal; } [data-font="FontAwesome"] { font-family: 'FontAwesome'; } a, .section-inner [data-font], .section-inner .icon, .section > a:hover { color: #0067c9; } .tag { background: #0067c9; } .header { background-color: #f9fafb; } .header .menu-item { color: hsl(206,8%,50%); } </style> <link rel="canonical" href="https://support.zenodo.org/help/en-gb/24-github-integration/96-how-does-a-citation-cff-file-affect-metadata-of-my-github-release"> <div class="wrapper js-wrapper"> <header class="header js-header"> <div class="container"> <span class="logo"> <a href="/help/en-gb"> <img src="/api/v1/system_assets/product_logo/1702248656"> </a> </span> <nav class="menu"> <a class="menu-item" href="https://zenodo.org">Home</a> <a class="menu-item" href="https://about.zenodo.org">About</a> <a class="menu-item" href="https://blog.zenodo.org">Blog</a> <a class="menu-item" href="https://help.zenodo.org">Help</a> <a class="menu-item" href="https://about.zenodo.org/projects/">Projects</a> <a class="menu-item" href="https://developers.zenodo.org">Developers</a> </nav> </div> <div class="container"> <div class="search"> <div class="search-field"> <svg class="icon icon-magnifier"> <use xlink:href="/assets/images/icons.svg#icon-magnifier"></use> </svg> <input class="js-search-input" type="search" placeholder="How can we help you? Search for an answer or a topic…"> </div> <ul class="search-results js-search-results" data-empty-placeholder="No results were found."></ul> </div> </div> </header> <nav class="breadcrumbs"> <div class="container"> <a class="breadcrumb" href="/help/en-gb"> <svg class="icon icon-knowledge-base"> <use xlink:href="/assets/images/icons.svg#icon-knowledge-base"></use> </svg> <span> Zenodo FAQ </span> </a> <a class="breadcrumb" href="/help/en-gb/24-github-integration"> <i data-font="FontAwesome"></i> <span> GitHub integration </span> </a> <a class="breadcrumb" href="/help/en-gb/24-github-integration/96-how-does-a-citation-cff-file-affect-metadata-of-my-github-release"> <svg class="icon icon-knowledge-base-answer"> <use xlink:href="/assets/images/icons.svg#icon-knowledge-base-answer"></use> </svg> <span> How does a CITATION.cff file affect metadata of my GitHub release? </span> </a> </div> </nav> <main class="main main--article" data-base-path='/help/%7Blocale%7D/24/96' data-available-locales='en-gb'> <article class="article"> <div class="container"> <h1> How does a CITATION.cff file affect metadata of my GitHub release? </h1> <div class="article-content" dir="auto"> <p>When we find a <code>CITATION.cff</code> file in your GitHub repository's root folder, we make a best-effort attempt at parsing Zenodo-compatible metadata from it.</p><p><br></p><p>For backwards-compatibility, if you have a <code>.zenodo.json</code> file in the repository, <strong>only the <code>.zenodo.json</code>'s metadata will be taken into account</strong>. Of course, any existing valid <code>CITATION.cff</code> file will still be used to display the citation box on the GitHub repository page, but will not affect in any way the metadata we extract for your published release Zenodo record.</p> </div> <div class="article-meta"> Published <time datetime="2024-01-31T12:53:49Z" title="2024-01-31 13:53:49 +0100">31/01/2024 13:53</time> </div> </div> </article> </main> <footer class="footer"> <div class="container"> <div class="footer-menu"> <div class="copyright"> © 2024 CERN. Licensed CC-BY 4.0 International </div> <nav class="menu"> <a class="menu-item" href="https://about.zenodo.org/privacy-policy">Privacy policy</a> <a class="menu-item" href="https://about.zenodo.org/cookie-policy/">Cookie policy</a> <a class="menu-item" href="https://about.zenodo.org/terms/">Terms of use</a> </nav> <div class="dropdown-picker language-picker"> <a class="btn btn--action" href="#" data-toggle="dropdown" aria-expanded="false"> English (Great Britain) <svg class="icon icon-arrow-down"> <use xlink:href="/assets/images/icons.svg#icon-arrow-down"></use> </svg> </a> <ul class="dropdown-menu dropdown-menu-right dropdown-menu-up" role="menu"> <li class="is-selected"> <a hreflang="en-gb" href="/help/en-gb/24-github-integration/96-how-does-a-citation-cff-file-affect-metadata-of-my-github-release"> <svg class="icon icon-checkmark"> <use xlink:href="/assets/images/icons.svg#icon-checkmark"></use> </svg> English (Great Britain) </a> </li> </ul> </div> </div> </div> </footer> </div> <script nonce="uaHmCz27TuOH1x69flTJ8Q=="> //<![CDATA[ if(window.fetch === undefined || window.Promise === undefined || Element.prototype.prepend === undefined){ var polyfillScriptTag = document.createElement('script'); polyfillScriptTag.setAttribute('src', '/assets/knowledge_base_public_polyfills-fb35a6fdad50d60f34f6339da7a38d3b89730fabb5e35ee4f945fdca9a03b183.js'); polyfillScriptTag.setAttribute('nonce', 'uaHmCz27TuOH1x69flTJ8Q=='); document.body.appendChild(polyfillScriptTag); } //]]> </script> <script src="/assets/knowledge_base_public-a03493a30925241bb10bc0d5b23e89485c62953244022ee2a3983c70500c4ba5.js" nonce="uaHmCz27TuOH1x69flTJ8Q=="></script>