Workflow to check for missing keyword linking #478
Conversation
hakonhagland
force-pushed
the
upd_gen_kw_uri
branch
2 times, most recently
from
f3ae7b5 to
d8455b8
Compare
|
I think the workflow might be failing due to keywords with the same name appears in different chapters. For example the |
A quick-fix could be to always link to the first occurring section? So references to ADD would link to chapter 6, since that is the first occurring (when sorting 6, 7, 8, 9, and 10 numerically) |
hakonhagland
force-pushed
the
upd_gen_kw_uri
branch
from
a2d9a02 to
2513f96
Compare
Reran a new version of fodt-gen-kw-uri-map (See PR OPM#478), also updated map to include the newly added SALTMF keyword.
|
This is ready for review now, so I will remove the "draft state". |
I think this should work for most cases. There are a few like RTEMPVD, which is in the PROPS and SOLUTION section, that is defined in the SOLUTION section. |
|
there is a failing check. What is that about? |
|
@lisajulia Please look at the Python stuff and merge if that is ok. |
hakonhagland
force-pushed
the
upd_gen_kw_uri
branch
from
2513f96 to
0cb473b
Compare
Reran a new version of fodt-gen-kw-uri-map (See PR OPM#478), also updated map to include the newly added SALTMF keyword.
The latest version of poetry causes the "poetry run fodt-gen-kw-uri-map" to fail for unknown reasons. Revert to poetry version 1.8.4 for now.
We need to reset it at the end of the paragraph not at the beginning of the next tag, since the table caption may include tags like text:s
Add an option --all that will run the keyword linker script on all files.
Added --check-changed option to the keyword linking script. If this option is given the script will not update any files but just check if any of the files would be changed by running the script. It will exit with code 1 if any file would be changed.
Run the script fodt-link-keywords --check-changed from the workflow to prevent PRs that would change the keyword linking from being merged.
If "fodt-gen-kw-uri-map --check-changed" detects a change, also print information about what changed. This can be helpful for debugging.
Since a keyword may defined in multiple chapters, e.g. ADD which is defined in chapters 6.3, 7.3, 8.3, 9.3, and 10.3, it is important to always link to the same chapter. To achieve this, we will always link to the first occuring definition. "First" here means to the chapter we the smalles numerical value. So ADD would here link to the definition in chapter 6.3 since 6.3 is smaller than 7.3, 8.3, 9.3 and 10.3.
Previous commits reverted the keyword_uri_map_generator.py file by mistake to a previous version.
hakonhagland
force-pushed
the
upd_gen_kw_uri
branch
from
0cb473b to
419ff64
Compare
Deactivate the second check until links have been updated in the chapters and we can expect the check to pass
| # fodt-gen-kw-uri-map --maindir=<main_dir> --keyword_dir=<keyword_dir> | ||
| # fodt-gen-kw-uri-map --maindir=<main_dir> \ | ||
| # --keyword_dir=<keyword_dir> \ | ||
| # --check-changed |
There was a problem hiding this comment.
Here, I ran fodt-link-keywords --check-changed it said:
INFO:root:Files have not changed.
but fodt-gen-kw-uri-map changed said:
INFO:root:Generated keyword URI map to /home/lnebel/git_repos/opm/opm-reference-manual/scripts/python/../../parts/meta/kw_uri_map.txt
There was a problem hiding this comment.
I guess this is because fodt-link-keywords --check-changed in this PR does not include the commit in #482 ?
There was a problem hiding this comment.
ah sorry I just saw I was actually using the branch haha/upd_link_kw2
Clarify that fodt-link-keywords will not actually save the generated map to file.
See #458 (comment) for more information.