Logo

Archiving at Zenodo

This use case describes the process of automatically archiving research results on Zenodo when a release is created in a repository. It also includes an option for manual submission. To ensure the long-term availability and citability of research results and to facilitate sharing with the research community.

Idea
Plan
Prototype
Pilot
Live

Overview

Value: This use case describes the process of automatically archiving research results on Zenodo when a release is created in a repository. It also includes an option for manual submission. To ensure the long-term availability and citability of research results and to facilitate sharing with the research community.

Problem: Research results are at risk of loss or fragmentation due to missing automated, citable archival processes integrated with version control.

Solution: To ensure the long-term availability and citability of research results and to facilitate sharing with the research community.

Who Benefits

Primary

  • Scientists

Secondary

  • Research community

Process

  1. Scientists prepare research results for publication.
  2. An automated action is triggered upon release creation to submit the results to Zenodo.
  3. The action authenticates with Zenodo using API credentials.
  4. Research results, including description and metadata, are submitted to Zenodo.
  5. Zenodo generates a DOI for the submission.
  6. The DOI is provided to the scientists for use in publications.

Requirements

People

  • Researchers
  • Students
  • Training staff

Data Inputs

  • Research results
  • Results on repository release events

Tools & Systems

  • Git
  • Zenodo
  • CI/CD pipeline

Policies & Compliance

  • Zenodo submission requirements
  • Long-term storage

Risks & Mitigations

  • The archiving process fails. Stakeholders are informed about the failure and potential solutions.

    • Notify stakeholders promptly
    • Provide manual fallback procedure

Getting Started

Prerequisites: Git access and configured tools/systems listed below.

  1. Prepare repository/template/content as needed
  2. Configure tooling, permissions, and integrations
  3. Run the workflow and review results

Resources

FAQ

How are research results archived automatically?

An automated CI/CD pipeline submits repository releases to Zenodo using API credentials.

Can a DOI be obtained for the archived data?

Yes, Zenodo generates a DOI for each submission for citation purposes.

Can submissions be done manually?

Yes, researchers can also submit results manually through Zenodo's web interface.

Glossary

Zenodo
Open-access repository for research outputs that supports DOI generation.
DOI
Digital Object Identifier, a persistent identifier for citing research results.
CI/CD Pipeline
Automated workflow to build, test, and deploy code or data, including Zenodo submission.
Repository Release
A versioned snapshot of a repository used as input for archiving.
0