Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Schema and Model Reference Documentation Generation Need Finer-Grained Branch Control in CI/CD #1463

Closed
3 tasks
aj-stein-nist opened this issue Sep 22, 2022 · 1 comment
Labels
enhancement Scope: CI/CD Enhancements to the project's Continuous Integration and Continuous Delivery pipeline.

Comments

@aj-stein-nist
Copy link
Contributor

aj-stein-nist commented Sep 22, 2022

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

  1. Where is the documentation being generated to? (Answer: It has to be main, always)
  2. Where is the document generation scripting coming from? (Answer: Right now, it comes from main; in the future, we need to be able to advance that independently from 1, arguably in separate repos if needed)
  3. Where is the Metaschema source for the resuling schemas come from (Answer: right now, that is the 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

  • All OSCAL website and readme documentation affected by the changes in this issue have been updated. Changes to the OSCAL website can be made in the docs/content directory of your branch.
  • A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
  • The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.
@aj-stein-nist
Copy link
Contributor Author

This appears to not be relevant anymore after the last website migration and release per discussion with @nikitawootten-nist.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Scope: CI/CD Enhancements to the project's Continuous Integration and Continuous Delivery pipeline.
Projects
Status: Done
Development

No branches or pull requests

1 participant