Finalize Release

You’re almost done - only a few steps remaining to complete the release! .

Candidate Branch

The next steps is to create a candidate branch in the upstream repository. The name of this branch should match the intended release tag. For example, name the branch 1.0.0 if this the project’s first release. You should create the candidate branch directly from the main branch of the upstream repository.

Next, update the contents of the DISCLAIMER.md file to the following:

Disclaimer
==========

This software has been approved for release by the U.S. Geological Survey
(USGS). Although the software has been subjected to rigorous review, the USGS
reserves the right to update the software as needed pursuant to further analysis
and review. No warranty, expressed or implied, is made by the USGS or the U.S.
Government as to the functionality of the software and related material nor
shall the fact of release constitute any such warranty. Furthermore, the
software is released on condition that neither the USGS nor the U.S. Government
shall be held liable for any damages resulting from its authorized or
unauthorized use.

Note

The main branch retains the original (provisional) text, as the main branch may contain active development in the future.

Warning

DO NOT merge the candidate branch back with the main branch.

Submit Release

You’re now ready to submit the upstream repository for release. To do so, submit a new issue at the USGS software management repository. Be sure to select the GitLab Official Release template from the Description dropdown menu. Fill out the checklist and submit the issue. You will be notified when the project is released, or if any modifications are necessary.

Once this is complete, your repository is public. However, there are a few steps remaining to complete the release.

Create Tagged Release

It’s now time to create the release itself. First, navigate to the upstream repository. Then, click the Releases button in the Deploy menu of the navigation sidebar. Click the Create Release button. Set the tag to the appropriate value for the release. You will need to click the Create tag option to create the tag itself.

Important

When creating the tag, be sure to create the tag from the release candidate branch. DO NOT create the tag from main.

Fill in the remaining fields as appropriate. If you are publishing a reusable software tool, you may want to attach release binaries so that users can quickly install the release. Click the Create release button once you are finished.

Activate DOI

The final step is to activate your DOI. Return to the reserved DOI, and double-check that all the fields are correct. When you are satisfied, follow the prompts to publish or activate the DOI. Be sure to add the DOI to your IPDS record once this is complete.

Celebrate!

Congratulations, you released your software! Users can now cite your work using its DOI, and the project will be listed on the USGS Software directory. Furthermore, the project is publicly available via the upstream repository, supporting open science. Nice work!