Archive a release from GitHub
This guide will help you create a Software record to be archived in Software Heritage. It assumes you have already enabled a repository.
If you need help to enable a repository, read the following guide:
Create a release
1
Open the profile menu and click GitHub
2
Select the repository
3
Click the Create release button
4
Create a release in GitHub. Find more information on how to manage releases here:
5
Wait for the release to be processed.
This could take some time, depending on the size of the release file and the load of Zenodo at that time.
6
When the release is finished, click the record DOI to go to the record
7
In the record page, check the archival status under External resources > Archived in. The record will be archived soon.
Debug a failed release
1
Select the repository (see step 2 above)
2
Select the failed release
3
In the collapsable window that just open, select Errors
4
Check if the error is related to your release metadata. If so, you can fix it and release your software again.
Note: you can use tools such as cff-converter to validate your CITATION.cff file.
Note: we provide complete examples of CITATION.cff and .zenodo.json files.
