Official Release

Once you have finished developing your code, you will need to take various steps to finalize the release. It is important that you complete these steps in order, as most tasks depend on the completion of previous steps. You should start by determining the tag for your release, although you should not actually create the tag at this point. Then, conduct the domain review.

Next, you will need to fulfill various administrative requirements. First, you will need to add a code.json metadata file to the repository, and submit the final repository for an administrative review. Once this is finished, you will need to complete an IPDS record for the planned release. Finally, reserve a DOI for the release.

Once the administrative steps are finished, you can complete the final steps of the release. First, you will need to create a release candidate branch. Then submit this branch to the official software release page so that the release can be made public. Finally, create the tagged release and activate the DOI.

flowchart TD tag1[Determine Tag] domain[Domain Review] json[code.json] admin[Administrative Review] ipds[IPDS Record] doi1[Reserve DOI] branch[Candidate Branch] submit[Submit Release] tag2[Create Tag/Release] doi2[Activate DOI] subgraph S1[Getting Started] direction LR tag1 --> domain end S1 --> S2 subgraph S2[Administrative] direction LR json --> admin admin --> ipds ipds --> doi1 end S2 --> S3 subgraph S3[Finalize] direction LR branch --> submit submit --> tag2 tag2 --> doi2 end click tag1 "./first-steps.html#tag" click domain "../reviews/domain.html" click json "./code-json.html" click admin "../reviews/admin.html" click ipds "./admin.html#ipds" click doi1 "./admin.html#reserve-doi" click branch "./finalize.html#candidate" click submit "./finalize.html#submit" click tag2 "./finalize.html#create-release" click doi2 "./finalize.html#activate-doi"

Steps of the release process.