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

[Bug]: Command does not fail on error only #1188

Open
dkd-kaehm opened this issue Dec 12, 2024 · 0 comments
Open

[Bug]: Command does not fail on error only #1188

dkd-kaehm opened this issue Dec 12, 2024 · 0 comments
Labels
bug Something isn't working triage

Comments

@dkd-kaehm
Copy link

Summary

The --fail-on-log and --minimal-test do not work as expected.
The command does not fail with --fail-on-log, if doc-sources contain errors only.

Expected:

The command

  • with --fail-on-error MUST fail, if there are errors (currently OK), but
  • with --fail-on-log or --minimal-test MUST fail, if there are errors OR warnings

NOTE:

This is difficult to reproduce, so I could not create a simple test case, but it is reproducible in our project in file(EXT:solr VersionMatrix.rst).
Most probably due of multiple tables producing the errors or other stuff containing in that file.

Code snippet that reproduces the problem

Prepare:

git clone https://github.com/TYPO3-Solr/ext-solr.git \
  && cd ext-solr \
  && git reset --hard 4f7b9a73e5cce6f7d836eb3726d0b3e2a48e4310

Test:

MUST fail, but doesn't (See: EXPECTED TO BE PRINTED! is not printed)

docker run --rm --pull always -v "$(pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --fail-on-log || echo 'EXPECTED TO BE PRINTED!'
rm -Rf Documentation-GENERATED-temp/

Fails only if warning is produced(relevant for info only!)

echo -e '\nproduce the warning: |nonExistingVar|' > Documentation/Appendix/VersionMatrix.rst
docker run --rm --pull always -v "$(pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --fail-on-log || echo 'EXPECTED TO BE PRINTED!'
rm -Rf Documentation-GENERATED-temp/

Expected output

Not relevant for rendering.

@dkd-kaehm dkd-kaehm added bug Something isn't working triage labels Dec 12, 2024
dkd-kaehm added a commit to dkd-kaehm/ext-solr that referenced this issue Dec 12, 2024
Currently it is not possible to use spans in tables, like it was possible on Sphix-Variant.
See: phpDocumentor/guides#1187

On the test `test_documentation` CI job, we want to generate the docs twice to be able to recognize the errors and warnings in the docs.
See: phpDocumentor/guides#1188

Fixes: TYPO3-Solr#4204
dkd-kaehm added a commit to dkd-kaehm/ext-solr that referenced this issue Dec 12, 2024
Currently it is not possible to use spans in tables, like it was possible on Sphix-Variant.
See: phpDocumentor/guides#1187

On the test `test_documentation` CI job, we want to generate the docs twice to be able to recognize the errors and warnings in the docs.
See: phpDocumentor/guides#1188

Fixes: TYPO3-Solr#4204
dkd-kaehm added a commit to TYPO3-Solr/ext-solr that referenced this issue Dec 12, 2024
Currently it is not possible to use spans in tables, like it was possible on Sphix-Variant.
See: phpDocumentor/guides#1187

On the test `test_documentation` CI job, we want to generate the docs twice to be able to recognize the errors and warnings in the docs.
See: phpDocumentor/guides#1188

Fixes: #4204
dkd-kaehm added a commit to dkd-kaehm/ext-solr that referenced this issue Jan 28, 2025
Known issues:

* Some RSTs missing index directive.
* Tables in `Documentation/Appendix/VersionMatrix.rst` are not renderable.
   See: TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument#251

---

Currently it is not possible to use spans in tables, like it was possible on Sphix-Variant.
See: phpDocumentor/guides#1187

On the test `test_documentation` CI job, we want to generate the docs twice to be able to recognize the errors and warnings in the docs.
See: phpDocumentor/guides#1188

Fixes: TYPO3-Solr#4204
dkd-kaehm added a commit to dkd-kaehm/ext-solr that referenced this issue Jan 28, 2025
Known issues:

* Some RSTs missing index directive.
* Tables in `Documentation/Appendix/VersionMatrix.rst` are not renderable.
   See: TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument#251

---

Currently it is not possible to use spans in tables, like it was possible on Sphix-Variant.
See: phpDocumentor/guides#1187

On the test `test_documentation` CI job, we want to generate the docs twice to be able to recognize the errors and warnings in the docs.
See: phpDocumentor/guides#1188

Fixes: TYPO3-Solr#4204
dkd-kaehm added a commit to TYPO3-Solr/ext-solr that referenced this issue Jan 28, 2025
Known issues:

* Some RSTs missing index directive.
* Tables in `Documentation/Appendix/VersionMatrix.rst` are not renderable.
   See: TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument#251

---

Currently it is not possible to use spans in tables, like it was possible on Sphix-Variant.
See: phpDocumentor/guides#1187

On the test `test_documentation` CI job, we want to generate the docs twice to be able to recognize the errors and warnings in the docs.
See: phpDocumentor/guides#1188

Fixes: #4204
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working triage
Projects
None yet
Development

No branches or pull requests

1 participant