common-cloud-controls icon indicating copy to clipboard operation
common-cloud-controls copied to clipboard

Develop Artifact Releasing Tool

Open damienjburks opened this issue 1 year ago • 4 comments

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 avatar Sep 09 '24 16:09 damienjburks

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

damienjburks avatar Sep 09 '24 16:09 damienjburks

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

damienjburks avatar Sep 10 '24 13:09 damienjburks

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?

sshiells-scottlogic avatar Sep 19 '24 17:09 sshiells-scottlogic

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

eddie-knight avatar Sep 19 '24 17:09 eddie-knight

This issue will be closed as stale in 7 days. Please update this issue if it is still needed.

github-actions[bot] avatar Oct 19 '24 22:10 github-actions[bot]

Closed as stale. An update may reopen this issue.

github-actions[bot] avatar Oct 27 '24 22:10 github-actions[bot]