Skip to content

Instantly share code, notes, and snippets.

@theresaanna
Last active September 23, 2016 20:10
Show Gist options
  • Save theresaanna/26e35c583fe4744738c6c03057442f2f to your computer and use it in GitHub Desktop.
Save theresaanna/26e35c583fe4744738c6c03057442f2f to your computer and use it in GitHub Desktop.
Alpha Software Inventory Schema - DC civic.json style
{
"agency": "DOABC",
"projects": [
{
"status": "Alpha",
"vcs": "git",
"repository": "https://github.com/presidential-innovation-fellows/mygov",
"homepage": "https://agency.gov/project-homepage",
"downloadURL": "https://agency.gov/project/dist.tar.gz",
"name": "mygov",
"description": "A Platform for Conecting People and Government",
"tags": [
"platform",
"government",
"connecting",
"people"
],
"languages": [
"java",
"python"
],
"contact": {
"email": "project@agency.gov",
"name": "Project Coordinator Name",
"twitter": "https://twitter.com/projectname",
"phone": "2025551313"
},
"partners": [
{
"name": "DOXYZ",
"email": "project@doxyz.gov"
}
],
"license": "https://path.to/license" OR null,
"openSourceProject": 1,
"governmentWideReuseProject": 0,
"exemption": null,
"updated": {
"lastCommit": "2016-04-30",
"metadataLastUpdated": "2016-04-13",
"sourceCodeLastModified": "2016-04-12"
}
}
]
}
@theresaanna
Copy link
Author

@okamanda

  • partners: I had envisioned both GSA and OMB listing the project, and we could potentially link them up somehow in the UI. I can't envision a problem, but that doesn't mean that there isn't one!
  • contact: that's a good question. Worth asking Jez about?
  • license: I didn't love the blended approach myself. I thought the URL option would be prohibitive, but I see your point. I will simplify this field.
  • updated: lastCommit is specifically for projects in VCS, whereas sourceCodeLastModified encompasses projects outside of VCS. Too confusing? should we remove lastCommit and keep sourceCodeLastModified or a renamed version of it?
  • exemption: The value of the field would be a number between 1-5, corresponding to the exemptions in the policy. Is this a bad idea?
  • inventory.json: I chose a different name so that there wouldn't be confusion with data.gov inventories, but I see that folks feel the opposite way, so I'll change it back.

@ckaran
Copy link

ckaran commented Sep 23, 2016

Would it be better to have a simple version field instead of the updated field? I was thinking it would be a string that follows the Semantic Versioning guidelines, which would make it easier for fully automated systems to detect if important changes have occurred.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment