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.

Sign up for GitHub

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

Jump to bottom

Development Snapshot Reference Model Docs Branch URL Assumes Origin Repo in All Cases #1286

Closed
aj-stein-nist opened this issue May 24, 2022 · 1 comment · Fixed by #1287
Closed

Development Snapshot Reference Model Docs Branch URL Assumes Origin Repo in All Cases #1286

aj-stein-nist opened this issue May 24, 2022 · 1 comment · Fixed by #1287
Assignees
@aj-stein-nist
Labels
bug Developer Experience Issues around enhancing and optimizing work for development of NIST OSCAL artifacts Scope: Documentation This issue relates to OSCAL documentation.
Milestone
v1.0.5

Comments

@aj-stein-nist
Copy link
Contributor

aj-stein-nist commented May 24, 2022 •
edited
Loading

Describe the bug

As an OSCAL developer, when using the model reference docs for a local build of pages.nist.gov website on my workstation, to know what repo branch in GitHub of the development snapshot of the model docs in the reference section originated from, I wanted the URL to correctly reflect if the branch is from the main origin repo (github.com/usnistgov/OSCAL) or one of the other developer forks where the branch is located.

Who is the bug affecting?

OSCAL developers who need to edit and review edits on local copies of the website for modification prior to PR review and publication.

What is affected by this bug?

Correctly identifying the branch where the documentation was generated from when not in develop and main branch. See #1150 (comment) and item 1 as the source of this report.

image

With an example, on #1150 at time of this writing, we properly identify the 87-mapping-model branch but the wrong GitHub [repo] and branch URL does not correctly point to https://github.com/david-waltermire-nist/OSCAL/tree as the template prefix string for that URL.

When does this occur?

Consistently when using ./build/ci-cd/generate-model-documentation.sh and ./docs/run-server.sh to build local copies of the pages.nist.gov/OSCAL site.

How do we replicate the issue?

  1. ./build/ci-cd/generate-model-documentation.sh
  2. ./docs/run-server.sh
  3. Observe and test GitHub and branch URLs on this newly generated page in your local copy

Expected behavior (i.e. solution)

URLs correctly point to proper repo and branches, like UI suggests.

Other Comments

N/A
@aj-stein-nist aj-stein-nist added bug Scope: Documentation This issue relates to OSCAL documentation. labels May 24, 2022
@aj-stein-nist aj-stein-nist mentioned this issue May 24, 2022
Merged
8 tasks
@david-waltermire david-waltermire added this to the OSCAL 1.0.5 milestone May 24, 2022
@aj-stein-nist aj-stein-nist added the Developer Experience Issues around enhancing and optimizing work for development of NIST OSCAL artifacts label May 24, 2022
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue May 25, 2022
@aj-stein-nist
Dynamically compute remote owner and repo name stub
e975656 
For the reference model documentation develop branch, we want the owner, repo name, and branch
to be dynamically computed and not statically generated and presumed to be from the official
main repo, usnistgov/OSCAL. Resolves usnistgov#1286.
@aj-stein-nist aj-stein-nist mentioned this issue May 25, 2022
Merged
7 tasks
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue May 25, 2022
@aj-stein-nist
Dynamically compute remote owner and repo name stub
49a6b29 
For the reference model documentation develop branch, we want the owner, repo name, and branch
to be dynamically computed and not statically generated and presumed to be from the official
main repo, usnistgov/OSCAL. Resolves usnistgov#1286.
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue May 25, 2022
@aj-stein-nist
Dynamically compute remote owner and repo name stub
ea0a6fe 
For the reference model documentation develop branch, we want the owner, repo name, and branch
to be dynamically computed and not statically generated and presumed to be from the official
main repo, usnistgov/OSCAL. Resolves usnistgov#1286.
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue May 25, 2022
@aj-stein-nist
Dynamically compute remote owner and repo name stub
21c3c1d 
For the reference model documentation develop branch, we want the owner, repo name, and branch
to be dynamically computed and not statically generated and presumed to be from the official
main repo, usnistgov/OSCAL. Resolves usnistgov#1286.
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue May 25, 2022
@aj-stein-nist
Dynamically compute remote owner and repo name stub
67fdcfc 
For the reference model documentation develop branch, we want the owner, repo name, and branch
to be dynamically computed and not statically generated and presumed to be from the official
main repo, usnistgov/OSCAL. Resolves usnistgov#1286.
david-waltermire pushed a commit that referenced this issue May 26, 2022
@aj-stein-nist
Dynamically compute remote owner and repo name stub (#1287)
0816abf 
For the reference model documentation develop branch, we want the owner, repo name, and branch
to be dynamically computed and not statically generated and presumed to be from the official
main repo, usnistgov/OSCAL. Resolves #1286.
@aj-stein-nist
Copy link
Contributor Author

aj-stein-nist commented May 26, 2022 •
edited
Loading

Checked and website correctly published in 0816abf.

A concurrent job failed because multiple PRs were merged into main as this CD job kicked off. Dave re-runned it and it passed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@aj-stein-nist aj-stein-nist

Labels
bug Developer Experience Issues around enhancing and optimizing work for development of NIST OSCAL artifacts Scope: Documentation This issue relates to OSCAL documentation.
Projects
None yet
Milestone
v1.0.5
2 participants
@david-waltermire @aj-stein-nist