Refine workflow process

[lukefretwell]

Related to: https://codecagov-playbook.readthedocs.io/en/latest/workflow/

Suggestions:

Process

Code.ca.gov publishing workflow includes a phased approach, first having CDT populate information proactively to display as many public projects as possible into code.ca.gov, then eventually enabling agencies to actively maintain their own data:

• Phase 1: CDT actively maintains/publishes agency code.json files

• Phase 2: Agencies self-manage/publish their respective code.json files

Phase 1

• Setup

  • CDT harvests data from agency projects located on publicly-available open source sharing platforms

• Release

  • CDT converts this data to code.json files for each active agency, which is then hosted in the code.ca.gov repository and published to code.ca.gov

• Updates

  • CDT will run the code.json automated harvest process on a daily basis

Phase 2

• Setup

  • Agency designates a Code Coordinator (CC)

  • Agency establishes a presence on an open source code sharing platform (e.g., GitHub, GitLab)

  • Agency creates code.json file and validates it is properly formatted

  • Agency publishes code.json file to the root of its primary website (e.g., https://cdt.ca.gov/code.json)

  • Agency notifies CDT of its code.json file by submitting an issue to the code.ca.gov repository

• Release

  • Agency publishes code to its open source code sharing platform (e.g., GitHub, GitLab)

  • Agency updates its code.json file

  • Agency validates its code.json is properly formatted

  • Agency publishes updated code.json file to its website

  • CDT automatically harvests this information from external agency websites files and publishes to code.ca.gov

• Updates

  • Agencies review/update code.json files each time custom created source code is published in a public or private repository

  • Agencies review the code.json file annual for accuracy.

  • CDT automatically harvests this information from external agency websites files and publishes to code.ca.gov