Repository Metadata

In compliance with M-16-21 and the SHARE IT Act, agencies are required to publish metadata on all custom-developed code. The code.json metadata standard was established to standardize the collection of information about the agency's software projects. It is comprised of 41 fields that capture project identification, technical details, development status, agency/team information, and more to provide a comprehensive overview of each software project. For more detailed information on the specific fields and their definitions, you can refer to the gov-codejson metadata documentation.

The OSPO built various tools to automate detecting, creating, and updating code.json files:

• codejson-generator: A form to generate code.json files
• automated-codejson-generator: A GitHub Action for creating and updating code.json
• repo-scaffolder: Metadata creation using the CLI

Learn more:

• gov-codejson
  • Overview
  • Schemas
• SHARE IT Act