You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
During code review for #941, we have discussed it in #941 (comment) but not tracked it yet. The code in generate-model-documentation.sh for the main branch and drafting website docs for the REVISION=latest configuration is not properly parsing out the proper number, so VERSION="${VERSION/#"v"}" is bound to just v, as evidenced in the current copy of the OSCAL docs. This will need a fix.
Who is the bug affecting?
Technical users who consume the OSCAL reference docs around the models.
What is affected by this bug?
Minor, but leads to confusion around what is the latest release version to which are documentation points to.
When does this occur?
Consistently
How do we replicate the issue?
Use the build/ci-cd/generate-model-documentation.sh script locally and run docs/run-server.sh to see the reference documentation points to only a version of v, not v1.x.y or something timely.
Expected behavior (i.e. solution)
The version number is properly parsed from git commands.
The text was updated successfully, but these errors were encountered:
aj-stein-nist
changed the title
Version's Number Missing in Generated Content from Model Documentation Generation Script
Version's Number Missing in Generated Docs from Model Documentation Generation Script
Jan 25, 2022
Per discussion with Dave, this was resolved as part of the 1.0.1 release cleanup by ensuring the git checkout depth is not at a max of 1. Pulling in full history allows tag resolution.
Describe the bug
During code review for #941, we have discussed it in #941 (comment) but not tracked it yet. The code in
generate-model-documentation.sh
for themain
branch and drafting website docs for theREVISION=latest
configuration is not properly parsing out the proper number, soVERSION="${VERSION/#"v"}"
is bound to justv
, as evidenced in the current copy of the OSCAL docs. This will need a fix.Who is the bug affecting?
Technical users who consume the OSCAL reference docs around the models.
What is affected by this bug?
Minor, but leads to confusion around what is the latest release version to which are documentation points to.
When does this occur?
Consistently
How do we replicate the issue?
Use the
build/ci-cd/generate-model-documentation.sh
script locally and rundocs/run-server.sh
to see the reference documentation points to only a version ofv
, notv1.x.y
or something timely.Expected behavior (i.e. solution)
The version number is properly parsed from
git
commands.The text was updated successfully, but these errors were encountered: