Creating Metadata for a Software Release

Overview

Questions

• What is a code.json file?
• How do you create a code.json file?
• What are the required fields in the code.json file for a USGS Software Release?

Objectives

• Explain what a code.json file is and how it is used.
• Create a code.json file with the minimum required fields for a USGS Software Release
• Validate a code.json file against the defined schema
• Update a code.json file for a new version of the software

Creating a code.json file

Write a code.json metadata file for this example software release.

Show me the solution

JSON

ADD code.json code here

Key Points

• A code.json file is a file formatted in JavaScript Object Notation (JSON) and contains project metadata. The code.json file is saved at the top-level of the project.
• USGS compiles all of the code.json files for public products in GitLab into an inventory that is required by Federal policy.
• You can use a code.json file template to begin creating your project metadata with the required fields.