Skip to content
This repository has been archived by the owner on Aug 6, 2021. It is now read-only.

Home

Jump to bottom
Jeff Fredrickson edited this page Nov 18, 2016 · 6 revisions

CodeInventory is a Ruby gem designed to automate the task of collecting source code metadata from various sources in order to build a code.json file in accordance with the federal source code policy.

Some agencies may have source code stored in multiple disparate locations. CodeInventory helps agencies automatically harvest metadata from these locations and output it in one consistent format (e.g., a code.json file).

How it Works

  1. You provide CodeInventory with a list of sources. A source is essentially a plugin to CodeInventory that knows how to harvest source code metadata from a specific place and return it to CodeInventory.
  2. CodeInventory goes through each source you give it, pulling metadata from the source.
  3. CodeInventory assembles a list of all your agency's source code projects based on all the metadata it collects.
  4. You can use this resulting list to create a code.json file.
Clone this wiki locally