agency-index.json

The SHARE IT Act requires federal agencies to publish metadata for their software projects. This metadata is compiled into an agency-index.json file, which serves as a centralized inventory of the agency's software portfolio.

Generate an agency-index.json file for submission

To create an agency-index.json:

Identify GitHub organizations and other platforms where source code is hosted
Generate the agency-index.json using the tools below. Learn more about usage in procedures.md

Provide the index at:

Agency's top level domain (TLD)
A GitHub repository

agency-index.json Fields

Field	Presence	Type	Description	Options/Examples
agency	required	str	The agency acronym for Clinger Cohen Act agency, as defined by the United States Government Manual.
measurementType/method	required	str	An enumerated list of methods for measuring the open source requirement.	- linesOfCode - modules - cost - projects - systems - other
measurementType/ifOther	optional	str	A one- or two- sentence description of the measurement type used, if 'other' is selected as the value of 'method' field.
releases	required	array	An array of code.json objects containing each versioned source code release made available.
version	required	str	The version of the metadata schema in use. Implements semantic versioning 2.0.0 rules as defined at http://semver.org.

View the agency-index.json schema here: https://github.com/DSACMS/gov-codejson/tree/main/schemas/agency-index/schema-2.0.0.json

More examples of agency index files can be found here: https://github.com/DSACMS/code-gov/tree/main/agency-indexes