Schema and Model Reference Documentation Generation Need Finer-Grained Branch Control in CI/CD #1463
Labels
enhancement
Scope: CI/CD
Enhancements to the project's Continuous Integration and Continuous Delivery pipeline.
User Story
As a NIST OSCAL tool developer, in order to ensure that schema and documents are generated correctly for the relevant branch and task, I want the CI/CD to be enhanced to allow more togglable control around what scripts and transforms are used from which repo and its branch and the explicit submodules' repos as pinned to that primary target branch for schema and model reference doc generation.
Goals
Below is a summary of the current state of the CI/CD approaches to these two tasks and potential future improvement as detailed by the creation of this issue. This issue is a consequence, but not an explicit dependency of aberrant behavior reported in usnistgov/metaschema#240 and usnistgov/metaschema#241. Feedback welcome!
For documentation generation
main
, always)main
; in the future, we need to be able to advance that independently from 1, arguably in separate repos if needed)main
develop
or git tag, as specified. IN the future, this can stay as is.)For schema generation
This is less complex, we can use schema generator from the Metaschema source branch. (Right now and the future this is ok: for OSCAL, we pin the submodule(s) so this already very precisely controlled as-is, so this is not a current development risk like the above)
Dependencies
usnistgov/metaschema#240 and usnistgov/metaschema#241
Acceptance Criteria
The text was updated successfully, but these errors were encountered: