search

finos / common-cloud-controls

FINOS Common Cloud Controls
https://www.finos.org/common-cloud-controls-project
Other
28 stars 34 forks source link

Develop Artifact Releasing Tool #339

Open damienjburks opened 2 weeks ago

damienjburks commented 2 weeks ago

Feature Request

Description of Problem:

At the moment, we do not have a formalized process for releasing artifacts and sharing them with our stakeholders. So, to address this gap, we need to develop the artifact-releasing tool first. This tool should be responsible for the following:

  1. Compiling all of the YAML files (controls, threats, features, etc.)
  2. Converting YAML files into human-readable format (PDF, MD)
  3. Converting YAML files into OSCAL-supported format and files
  4. Create a version-controlled zip file or package with all the artifacts inside.
damienjburks commented 2 weeks ago

@eddie-knight I've created the issue & mapped it to the PR - will update the description later.

damienjburks commented 2 weeks ago

Architecture diagram is located in #334 - we are using Golang for this.

sshiells-scottlogic commented 1 week ago

Sorry if I missed this, is there a plan for storing versions of the compiled output?

I think it would be quite nice, if there was a "latest" verson of the markdown, along with the cal ver version, and that way people would be able to track the changes via the file history diff to more easily see the changes via the diff?

eddie-knight commented 1 week ago

Yeah @sshiells-scottlogic, the goal is for the "production ready" assets to be stored in GitHub Releases