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

Integration of Metaschema M4 features into OSCAL repository #758

Merged
merged 131 commits into from
Dec 21, 2020

Conversation

david-waltermire
Copy link
Contributor

@david-waltermire david-waltermire commented Sep 17, 2020

Committer Notes

This integration branch integrates the Metaschema M4 toolchain into the OSCAL repository. This will allow use of advanced Metaschema features in the OSCAL project.

This integration branch is tracking the metaschema submodule integration branch (PR usnistgov/metaschema#72). As a result, the metaschema PR needs to be merged before this PR can be merged.

In this integration branch we plan to:

  1. Setup CI/CD scripting for building OSCAL artifacts
    • Schema generation
      • Generation of XML Schema files
      • Generation of JSON Schema files
    • Generation of Schematron files for checking co-constraints
      • XML support
      • JSON support
    • Generation of content converters
      • XML content converters
      • JSON content converters
    • Generation of model documentation
      • Model maps
        • XML model maps
        • JSON model maps
        • YAML model maps
      • Model documentation
        • XML model documentation
        • JSON model documentation
        • YAML model documentation
  2. Up-convert all OSCAL metaschema to new M4 format
    • Verify base conversion produces valid and correct metaschema
    • Automate a variety of adjustments to use new features
      • TBD
  3. Make manual adjustments to models based on a comprehensive review
    • All adjustments have been made
  4. Design updated model documentation format
    • Fix know issues
    • Add support for documenting constraints

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Have you squashed any non-relevant commits and commit messages? [instructions]
  • Do all automated CI/CD checks pass?

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you included examples of how to use your new feature(s)?
  • Have you updated all OSCAL website and readme documentation affected by the changes you made? Changes to the OSCAL website can be made in the docs/content directory of your branch.

@david-waltermire david-waltermire linked an issue Oct 30, 2020 that may be closed by this pull request
3 tasks
@david-waltermire david-waltermire linked an issue Nov 13, 2020 that may be closed by this pull request
13 tasks
@david-waltermire david-waltermire linked an issue Nov 17, 2020 that may be closed by this pull request
3 tasks
@david-waltermire david-waltermire linked an issue Nov 19, 2020 that may be closed by this pull request
5 tasks
@david-waltermire david-waltermire linked an issue Nov 20, 2020 that may be closed by this pull request
3 tasks
@david-waltermire david-waltermire marked this pull request as ready for review December 21, 2020 00:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment