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

The coupling of validation and list-images-missing obscures image errors #30

Closed
ghost opened this issue Jun 21, 2021 · 1 comment
Closed
Labels
cat-bug Something is broken topic-action Related to individual GitHub actions from `gha-...` branches of this repo

Comments

@ghost
Copy link

ghost commented Jun 21, 2021

gha-select-dcs's list-validate mode optimizes the list of documents to validate within a repo, so we validate as few times as possible. That optimization is correct for daps validate itself, as the actual XML validation validates all parts of the current MAIN irrespective of the ROOTID.

The optimization is not correct for daps list-images-missing. That target only checks for images needed to build the current document (i.e. within the scope of the current ROOTID). By and large, results will still be correct as long as we're preferring validation with DC-*-all files (which have no ROOTID). Results will not be correct though for l10n dirs in doc-sle for languages where:

  1. more than one guide is shipped and
  2. no DC-*-all file is included.

As an example, the broken state of SUSE/doc-sle@15f3b214 gives an a-OK result if you run list-images-missing with the wrong DC file:

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

doc-sle :15f3b2148 > daps -d l10n/sles/de-de/DC-SLES-deployment list-images-missing 
All images for document "book-deployment" exist.

I am not sure whether it makes sense to broaden the scope of list-images-missing (or validate --validate-images) so it matches the scope of validate itself. (However, --validate-ids does match the scope of validate itself, so I guess there's precedent.)

@ghost ghost added the cat-bug Something is broken label Jun 21, 2021
@ghost ghost changed the title The coupling of validation and list-images-missing is problematic The coupling of validation and list-images-missing obscures image errors Jun 21, 2021
@ghost ghost added the topic-action Related to individual GitHub actions from `gha-...` branches of this repo label Jan 17, 2022
@ghost
Copy link
Author

ghost commented Feb 7, 2022

Fixed in DAPS 3.3, which is out now.

@ghost ghost closed this as completed Feb 7, 2022
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cat-bug Something is broken topic-action Related to individual GitHub actions from `gha-...` branches of this repo
Projects
None yet
Development

No branches or pull requests

0 participants