Docs: provide option to skip analysis in doc-check#282
Open
bkhouri wants to merge 1 commit into
Open
Conversation
bkhouri
force-pushed
the
t/main/gh281_add_doc_check_input_options
branch
4 times, most recently
from
f31e5a2 to
ebccca7
Compare
Contributor
Author
|
Since I am unable to re-trigger the failed GitHub Actions, I'm closing and re-opening the PR to trigger them |
bkhouri
force-pushed
the
t/main/gh281_add_doc_check_input_options
branch
from
ebccca7 to
eae5369
Compare
bkhouri
commented
Jun 10, 2026
bkhouri
force-pushed
the
t/main/gh281_add_doc_check_input_options
branch
2 times, most recently
from
6e461f1 to
ec74680
Compare
bkhouri
force-pushed
the
t/main/gh281_add_doc_check_input_options
branch
3 times, most recently
from
c9aa458 to
843dda3
Compare
Some projects may not want to run the `--analyze` option on the DocC generation until they are ready. Provide an workflow input option to skip the analyze. While at it, update the `check-docs.sh` script to accept arugments instead of relying on environment variables being set. This allows more easily run the script at-desk. Fixes #2181
bkhouri
force-pushed
the
t/main/gh281_add_doc_check_input_options
branch
2 times, most recently
from
2bfd438 to
07dc924
Compare
FranzBusch
reviewed
Jun 22, 2026
FranzBusch
left a comment
FranzBusch
left a comment
Member
There was a problem hiding this comment.
Overall LGTM a few minor nits. Thanks for adding a doc for the check!
| default: "" | ||
| docs_check_targets: | ||
| type: string | ||
| description: "List of targets to check for documentation. Defaults to empty string." |
Member
There was a problem hiding this comment.
Empty string means that it looks at .spi.yml right?
| default: "" | ||
| docs_check_macos_targets: | ||
| type: string | ||
| description: "List of targets to check for documentation. Defaults to empty string." |
Comment on lines
+19
to
+20
| - the `docs_check_targets` / `docs_check_macos_targets` input, **or** | ||
| - a `documentation_targets` entry in a `.spi.yml` file at the repository root. |
Member
There was a problem hiding this comment.
Can we swap this since I expect the second one to be the one we want folks to use
| - the `docs_check_targets` / `docs_check_macos_targets` input, **or** | ||
| - a `documentation_targets` entry in a `.spi.yml` file at the repository root. | ||
|
|
||
| If neither is provided, the job exits successfully without checking anything. |
Member
There was a problem hiding this comment.
This might be a bit unexpected. Shouldn't this fail the job?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Some projects may not want to run the
--analyzeoption on the DocC generation until they are ready.Provide an workflow input option to skip the analyze. While at it, update the
check-docs.shscript to accept arugments instead of relying on environment variables being set. This allows more easily run the script at-desk.Fixes #281