The following workflow is divided into two main parts:
- Publishing your code/software on GitHub
- Getting DOI for your code/software
Publishing your code on GitHub:
- Log in to your GitHub account if you are not logged in.
- Create a new repository:
- Head over to the top of green button in the middle of the page to generate a new repository.
- Fill in the repository data, e.g., name (make the name descriptive), description.
- Make the repo public to be able to archive it.
- Initiate the repository with a README or you can add it later.
- Follow guidelines here to see what you should include in your README.md.
- Add your scripts and other related files to your software.
- Add licensing information to your repository.
An important tip: Provide an informative descriptive for your code!
Getting a DOI for your software:
Link GitHub with Zendodo:
- Head over to https://zenodo.org
- You can log in to Zenodo with your GitHub account.
- You may need to authorize Zenodo application
- Zenodo will redirect you back to GitHub for Authorization
- Choose the repository webhooks options
- From the drop-down menu next to your email address at the top of the page, select GitHub.
- You will be presented with a list of all your Github repositories
- Archiving a repo:
- Select a repository you want to archive on Zenodo.
- Toggle the "on" button next to the repository ou need to archive.
- Click on the Repo that you want to reserve.
- Click on Create release button at the top of the page. Zenodo will redirect you back to GitHub’s repo page to generate a release
- Trigger Zenodo to Archive your repository
- Go to GitHub and create a release. Zenodo will automatically download a .zip-ball of each new release and register a DOI.
- If this is the first release of your code then you should give it a version number of v1.0.0. Add description for your release then click the Publish release button.
- Zenodo takes an archive of your GitHub repository each time you create a new Release
- To ensure that everything is working:
- go to https://zenodo.org/account/settings/github/, or the Upload page (https://zenodo.org/deposit), you will find your repo is listed
- Click on the repo, Zenodo will redirect you to a page that contains a DOI for your repo will the information that you added to the repo.
- You can edit the archive on Zenodo and/or publish a new version of your software.
- It is recommended that you add a description for your repo and fill in other metadata in the edit page.
- Your code is now published on a Github public repository and archived on Zenodo.
Your software is now published on a Github public repository and has a DOI that can be used for citations.