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

Use exact match when dealing with MooseDocs gitutils #29097

Closed
milljm opened this issue Nov 19, 2024 · 1 comment · Fixed by #29100
Closed

Use exact match when dealing with MooseDocs gitutils #29097

milljm opened this issue Nov 19, 2024 · 1 comment · Fixed by #29100
Assignees
@milljm
Labels
C: Documentation C: Python for content in the python directory T: task An enhancement to the software.

Comments

@milljm
Copy link
Member

milljm commented Nov 19, 2024 •
edited
Loading

Motivation

By default gitutils in MooseDocs uses recursion when querying git submodules. This can inadvertently bring in multiple "moose's". And as such will list the wrong hash when building SQA documentation.

Current design example. Take Bison:

$ git submodule status --recursive
-72ea8f9c1b217183d3bed5d92d0c2c30a0ddbc22 fipd-bison-integration-data
 c1769ac072f67eeb0a13e0b5f8b3a4933fe0e768 iapws95 (remotes/origin/master)
-4f939da0bdc0d9c80e81b32de2b0424a12bedbcf iapws95/moose
 248bc872a379a2df74f742e817c60ce516d35880 moose (snapshot-20-10-27-42157-g248bc872a3)
-c8c9ce4259115973f147e345608450d87dc390c4 moose/framework/contrib/wasp
 19f9bb9a092270d4a317db0c6d21a7a495af1e27 moose/large_media (remotes/origin/phase_field_old_wiki-159-g19f9bb9)
-5483644b60cc538a4b54d312f28835bd94107627 moose/libmesh
-46cd0142492ae4bf09a7f159b319dc1b1f304591 moose/modules/chemical_reactions/contrib/thermochimica
-40734821205f76caf09c08bfa1e2406871def636 moose/modules/fluid_properties/contrib/air
-87bc53ea23a94a85eeecd04ca1f3c0bf5c1837c3 moose/modules/fluid_properties/contrib/carbon_dioxide
-9e24dd9a38fc513afc818f337fd0580ae0f37353 moose/modules/fluid_properties/contrib/helium
-0790bb70016ab20ca80ac7324c26ce18c86521cd moose/modules/fluid_properties/contrib/nitrogen
-c72539d3420295b4fb68f55eeb889f7563af0ff8 moose/modules/fluid_properties/contrib/potassium
-691e39cc4380135d5f75a376247ba29b49a78e9a moose/modules/fluid_properties/contrib/saline
-d183a947b54f374bce4b5498d8bd6e13bf504f43 moose/modules/fluid_properties/contrib/sodium
-884615b3b35f593c20bfbf62c2bc2c951dc4e565 moose/modules/solid_mechanics/contrib/neml2
-9cffe78795669c5fbaf7ca6d864d230635faa5ef moose/petsc

MooseDocs ends up using iapws95/moose instead of moose, when generating this page: https://mooseframework.inl.gov/bison/sqa/bison_sll.html (current version of moose identified as being used to build Bison).

Design

Allow the git extension to supply recursion at the document level, instead of by global default.

Impact

Correct reporting of certain SQA documents when rendering the MOOSE sited.
@milljm milljm added T: task An enhancement to the software. C: Documentation C: Python for content in the python directory labels Nov 19, 2024
@milljm milljm self-assigned this Nov 19, 2024
milljm added a commit to milljm/moose that referenced this issue Nov 19, 2024
@milljm
Do not perform recursion by default
d8759d3 
Add ability to perform recursion by request from the markdown document.

Closes idaholab#29097
@milljm milljm mentioned this issue Nov 19, 2024
Merged
@milljm
Copy link
Member Author

milljm commented Nov 19, 2024

After speaking with Cody, we want to keep --recursive, but do an exact match on repo name instead.

milljm added a commit to milljm/moose that referenced this issue Nov 19, 2024
@milljm
perform exact match
57593b7 
Perform an exact match instead of relying on endswith. This should
fix same-named recursive repos within the project.

Closes idaholab#29097
@milljm milljm changed the title Add recursive option to MooseDocs gitutils Use exact match when dealing with MooseDocs gitutils Nov 19, 2024
milljm added a commit to milljm/moose that referenced this issue Dec 12, 2024
@milljm
perform exact match
cea159c 
Perform an exact match instead of relying on endswith. This should
fix same-named recursive repos within the project.

Closes idaholab#29097
milljm added a commit to milljm/moose that referenced this issue Dec 12, 2024
@milljm
iterate over length sorted list
c4e2434 
When matching for submodule repos, sort by length. This will ensure the
.endswith(str) will match toplevel submodules before nested submodules
of the same name.

Nested modules can still be matched, but the user will need to specify
that in markdown by supplying the full path, exp:

[!git!submodule-hash url=https://github.com/idaholab/moose](contribs/moose)

instead of

[!git!submodule-hash url=https://github.com/idaholab/moose](moose)

Of course, (moose) will still match properly, if this is the only 'moose'
submodule in the repo.

Closes idaholab#29097
@milljm milljm closed this as completed in 8a19d9c Dec 12, 2024
@milljm milljm mentioned this issue Jan 13, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@milljm milljm

Labels
C: Documentation C: Python for content in the python directory T: task An enhancement to the software.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

sort submodules by length when performing .endswith() match milljm/moose
1 participant
@milljm