You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/agency-index.md
+62-2Lines changed: 62 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
##agency-index.json
1
+
# agency-index.json
2
2
3
3
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.
4
4
5
-
View the agency-index.json schema here: https://github.com/DSACMS/gov-codejson/tree/main/schemas/agency-index/schema-2.0.0.json
5
+
## Generate an agency-index.json file for submission
6
6
7
7
To create an agency-index.json:
8
8
1. Identify GitHub organizations and other platforms where source code is hosted
@@ -13,4 +13,64 @@ To create an agency-index.json:
13
13
- Agency's top level domain (TLD)
14
14
- A GitHub repository
15
15
16
+
## agency-index.json Fields
17
+
18
+
<table>
19
+
<thead>
20
+
<tr>
21
+
<th>Field</th>
22
+
<th>Presence</th>
23
+
<th>Type</th>
24
+
<th>Description</th>
25
+
<th>Options/Examples</th>
26
+
</tr>
27
+
</thead>
28
+
<tbody>
29
+
<tr>
30
+
<td>agency</td>
31
+
<td>required</td>
32
+
<td>str</td>
33
+
<td>The agency acronym for Clinger Cohen Act agency, as defined by the United States Government Manual.</td>
34
+
<td></td>
35
+
</tr>
36
+
<tr>
37
+
<td>measurementType/method</td>
38
+
<td>required</td>
39
+
<td>str</td>
40
+
<td>An enumerated list of methods for measuring the open source requirement.</td>
41
+
<td>
42
+
- linesOfCode
43
+
- modules
44
+
- cost
45
+
- projects
46
+
- systems
47
+
- other
48
+
</td>
49
+
</tr>
50
+
<tr>
51
+
<td>measurementType/ifOther</td>
52
+
<td>optional</td>
53
+
<td>str</td>
54
+
<td>A one- or two- sentence description of the measurement type used, if 'other' is selected as the value of 'method' field.</td>
55
+
<td></td>
56
+
</tr>
57
+
<tr>
58
+
<td>releases</td>
59
+
<td>required</td>
60
+
<td>array</td>
61
+
<td>An array of code.json objects containing each versioned source code release made available. </td>
62
+
<td></td>
63
+
</tr>
64
+
<tr>
65
+
<td>version</td>
66
+
<td>required</td>
67
+
<td>str</td>
68
+
<td>The version of the metadata schema in use. Implements semantic versioning 2.0.0 rules as defined at http://semver.org.</td>
69
+
<td></td>
70
+
</tr>
71
+
<tbody>
72
+
<table>
73
+
74
+
View the agency-index.json schema here: https://github.com/DSACMS/gov-codejson/tree/main/schemas/agency-index/schema-2.0.0.json
75
+
16
76
More examples of agency index files can be found here: https://github.com/DSACMS/code-gov/tree/main/agency-indexes
0 commit comments