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.

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

Scope of validate --validate-images is different from validate & validate --validate-ids #627

Closed
ghost opened this issue Jun 22, 2021 · 1 comment
Labels

Comments

@ghost
Copy link

ghost commented Jun 22, 2021

Problem description

Both normal XML validation (validate) and ID validation (validate --validate-ids) check the entire document, ignoring the ROOTID.

Image validation (validate --validate-images) however, is checking only within the scope of the ROOTID.

Within our GHA CI, this is now a practical issue -- we optimize the number of documents we validate based on the assumption that the ROOTID will be ignored. That is only true for 2/3 of the checks we run, though. This means that in some cases, our CI will overlook the fact that images are missing and falsely give a positive result (cf. openSUSE/doc-ci#30).

(This issue is not completely new, it did exist within our Travis CI script already. However, the GHA script adds an automatic optimization of which DC files to validate, so the issue is exacerbated compared to our previous manual optimizations applied via the .travis-check-docs file in our repos.)

Expected behavior

Make sure all behaviors of the validate target are scoped the same way. As I don't really want to touch the CI too much, I'd selfishly suggest ignoring the ROOTID parameter for the entire validate target.

Steps to reproduce problem

Check out the broken state of SUSE/doc-sle@15f3b21 and run validate --validate-images or list-images-missing with different DC files:

doc-sle :15f3b2148 > daps -d l10n/sles/de-de/DC-SLES-all validate --validate-images 
The following images are missing:
container_support_matrix
scc_eye_icon

doc-sle :15f3b2148 > daps -d l10n/sles/de-de/DC-SLES-deployment validate --validate-images 
All images for document "book-deployment" exist.
@ghost
Copy link
Author

ghost commented Aug 27, 2021

Fixed with 05d1625.

@ghost ghost closed this as completed Aug 27, 2021
ghost pushed a commit that referenced this issue Feb 3, 2022
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

0 participants