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

MooseDocs CIVET extension mergeresults command always shows most up-to-date hashes #29565

Open
cticenhour opened this issue Dec 17, 2024 · 0 comments · May be fixed by #29566
Open

MooseDocs CIVET extension mergeresults command always shows most up-to-date hashes #29565

cticenhour opened this issue Dec 17, 2024 · 0 comments · May be fixed by #29566
Assignees
@cticenhour
Labels
C: Documentation C: Python for content in the python directory P: normal A defect affecting operation with a low possibility of significantly affects. T: defect An anomaly, which is anything that deviates from expectations.

Comments

@cticenhour
Copy link
Member

Bug Description

When using the !civet mergeresults command in MooseDocs, it currently shows links associated with the CI for the most up-to-date git commit SHAs for the repository being referenced in the extension. This is great when websites are built for production (e.g., https://mooseframework.inl.gov), but awful if a local copy of the website is being built using an older copy of the code (say, when you want to generate documentation for an older release). This causes confusion because the links to the CI references no longer connect to the code or documentation being rendered.

Steps to Reproduce

Use !civet mergeresults in MooseDocs with the CIVET Extension properly enabled when using an older version of MOOSE or MOOSE-based applications.

Impact

This is an annoyance, and possible violation of SQA compliance if this is being used in audited documentation.

[Optional] Diagnostics

No response
@cticenhour cticenhour added T: defect An anomaly, which is anything that deviates from expectations. P: normal A defect affecting operation with a low possibility of significantly affects. C: Documentation C: Python for content in the python directory labels Dec 17, 2024
@cticenhour cticenhour self-assigned this Dec 17, 2024
cticenhour added a commit to cticenhour/moose that referenced this issue Dec 17, 2024
@cticenhour
Change default for MooseDocs CIVET mergeresults command
e484d1c 
The command will now always look to the current git commit SHA to determine the linked CI results by default. The old behavior is available using use_current_hash=False in the command.

This commit also adds documentation for MooseDocs CIVET extension

Refs idaholab#29565
cticenhour added a commit to cticenhour/moose that referenced this issue Dec 17, 2024
@cticenhour
Add MooseDocs entry for docs CIVET extension changes
1b0401f 
Refs idaholab#29565
@cticenhour cticenhour linked a pull request Dec 17, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cticenhour cticenhour

Labels
C: Documentation C: Python for content in the python directory P: normal A defect affecting operation with a low possibility of significantly affects. T: defect An anomaly, which is anything that deviates from expectations.
Projects
None yet
Milestone
No milestone
1 participant
@cticenhour