Skip to content

Commit

Permalink
Clarify how to determine target catalog oscal-version (usnistgov#1386)
Browse files Browse the repository at this point in the history
* Revised text to address ambiguity around handling `oscal-version` in the generated catalog target based on the versions provided in the imports and source profile. Resolves usnistgov#1272.
* Adding swap space to resolve memory issue with Hugo build
  • Loading branch information
david-waltermire authored and aj-stein-nist committed Jun 29, 2023
1 parent b5ff619 commit 9681a6d
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
5 changes: 5 additions & 0 deletions .github/workflows/workflow-generate-website-reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,11 @@ jobs:
run: |
cd "${{ env.BRANCH_PATH }}/build"
go install -tags "extended" github.com/gohugoio/hugo
- name: Setup Swap Space
# Since Hugo is requiring more memory
uses: pierotofy/set-swap-space@49819abfb41bd9b44fb781159c033dba90353a7c
with:
swap-size-gb: 10
# Build Artifacts
# ---------------
- name: Generate Model Reference Documentation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1389,7 +1389,8 @@ control:
<p><req level="must" id="req-meta-version">The value of metadata:version in the target MUST be set with a string that identifies the version of that document.</req> <req level="should" id="req-meta-version-track">The metadata:version SHOULD be used to track updates to this specific output document.</req></p>
</li>
<li>
<p><req level="must" id="req-meta-oscal-version">The value of metadata:oscal-version in the target MUST be set with a string that identifies the version of OSCAL used by this tool to resolve the profile (ex. 1.0.0). This value MUST be determined by compiling the oscal-versions from each imported document and the source profile, and taking the most recent minor version. If this version is more recent than what the resolution tool is using, then the value of oscal-version MUST be the version that the tool used internally.</req> <req level="must" id="req-meta-oscalversion-error">If any of the above OSCAL versions (imported document versions, source profile version, tool version) are of a different major version (the first digit differs), the tool SHOULD provide an error and cease processing.</req></p>
<p><req level="must" id="req-meta-oscal-version">The value of metadata:oscal-version in the target MUST be set to the value of the corresponding object (oscal-version) in the source profile.</req></p>
<p><req level="may" id="req-meta-oscalversion-error">If, in processing, a resolver encounters an imported profile or catalog source whose stated oscal-version denotes a version after the oscal-version of the profile, the resolver MAY report a fatal processing error and stop processing. "After" is defined according to the [precedence rules](https://semver.org/#spec-item-11) of Semantic Versioning 2.0, in which 1.0.1 is after 1.0.1-draft.</req></p>
</li>
<li>
<p><req level="must" id="req-meta-last-modified">The value of metadata:last-modified in the target MUST be set with a valid timestamp representing the time the profile resolution completed.</req></p>
Expand Down

0 comments on commit 9681a6d

Please sign in to comment.