Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Zenodo Archiving of new releases #98

Open
mohammadamint opened this issue Nov 8, 2023 · 3 comments
Open

Zenodo Archiving of new releases #98

mohammadamint opened this issue Nov 8, 2023 · 3 comments
Assignees
Labels
enhancement New feature or request

Comments

@mohammadamint
Copy link
Collaborator

@FLomb To properly archive each new release on Zenodo, the following steps are required:

1. adding the .zenodo.json file to the repository with the following structure:

{
  "creators": [
    {
      "affiliation": "affiliation of the first author",
      "name": "name of the first author",
      "orcid": "orcid id of the first author (optional)"
    },
  ],
  "keywords": [
    "keyword 1",
    "keyword 2",
    "keyword 3"
  ],
  "license": "software license",
  "upload_type": "software"
}

2. liking the github repo to Zenodo

@mohammadamint mohammadamint added the enhancement New feature or request label Nov 8, 2023
@FLomb
Copy link
Contributor

FLomb commented Nov 8, 2023

Hi @mohammadamint, the automated archival of new releases on Zenodo is something we already have in place for other repos (e.g., RAMP-mobility: https://zenodo.org/records/4849423). So far, I have managed to make it happen by making use of an in-built functionality of Zenodo that allows you to connect to your GitHub repositories from the website interface. And I have set up the same functionality for RAMP, so it should happen when we make a new release. Is there a reason for having the zenodo.json file too?

@mohammadamint
Copy link
Collaborator Author

Hi @FLomb. I believe it is not mandatory but useful for a cleaner and more customizable Zenodo citation. An alternative suggested by Zenodo is CITATION.cff.

@mohammadamint
Copy link
Collaborator Author

@FLomb We also need to add the zenodo DOI tag to the GitHub page README.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants