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

feat: Establish workflow for lula validation identifiers #361

Merged
merged 8 commits into from
Apr 12, 2024

Conversation

brandtkeller
Copy link
Member

Closes #226

Improving the validation identifiers to improve the developer experience and reduce potential errors due to miss identifying a link.

Changes

  • Provide better separation between the OSCAL and Lula validations
    • BackMatterToMap() now strictly provides a map[string]string object for which identified validations will then be unmarshalled and placed in the validationMap.
      • This removes the need to place any identifier in the back-matter validation
      • This also provides a greater separation from OSCAL functionality and Lula Validation functionality
  • Currently backwards compatible - this can be discussed and removed
  • Establishes the use of rel for which we could expand to include validation "types"
  • validationMap serves future external processing - such that when an external document is unmarshalled, we can place 1 -> N validations into the map rather than having to open the same file multiple times for different validations (reuse).
  • Move the unmarshall and validation of a Validation from a String (back-matter.resource[_].description) to the common package to delineate that functionality from OSCAL functionality.

@brandtkeller brandtkeller added this to the v0.2.0 Release milestone Apr 10, 2024
@brandtkeller brandtkeller self-assigned this Apr 10, 2024
Copy link

netlify bot commented Apr 10, 2024

Deploy Preview for lula-docs canceled.

Name Link
🔨 Latest commit c965a86
🔍 Latest deploy log https://app.netlify.com/sites/lula-docs/deploys/6617de98c4f9a5000869bbba

@brandtkeller brandtkeller added the enhancement New feature or request label Apr 10, 2024
@brandtkeller brandtkeller marked this pull request as ready for review April 10, 2024 19:57
@brandtkeller brandtkeller marked this pull request as draft April 10, 2024 21:55
@brandtkeller brandtkeller marked this pull request as ready for review April 10, 2024 23:01
meganwolf0
meganwolf0 previously approved these changes Apr 11, 2024
@brandtkeller brandtkeller merged commit 46d840b into main Apr 12, 2024
7 checks passed
@brandtkeller brandtkeller deleted the 226_validation-identifier branch April 12, 2024 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Improve Lula validation identifier
4 participants