QA » openQA Project

Something else is missing:

The bundle install is happening because asciidoctor could not be found, and that's a different issue, but not because of this script (tools/generate-docs).

Since it was already present before that pr was merged; My money is that something changed for the PDF generation, and asciidoctor-pdf is not available anymore. At this point, we could rely on the HTML-only format and remove the need for distributing a PDF.

squamata@f5be1bfa2cdf:/opt/testing_area/openQA> ag tools/generate-documentation
tools/ci/build-docs
7:    bash -xe tools/generate-documentation
12:    bash -xe tools/generate-documentation https://token@github.com/os-autoinst-bot/openQA.git gh-pages-"$(date +%y%m%d%H%M%S)"

tools/generate-documentation
19:# PUBLISH=1 tools/generate-documentation https://github.com/andrii-suse/openQA.git gh-pages
20:# PUBLISH=1 GITHUB_TOKEN=xxxx271e PULL_REQUEST_USER=andrii-suse tools/generate-documentation https://token@github.com/os-autoinst-bot/openQA.git gh-pages-$(date +%y%m%d%H%M%S)

okurz wrote in #note-2:

maybe this is related to https://github.com/os-autoinst/openQA/pull/5389 ?

sudo zypper -n in -C 'rubygem(asciidoctor)' 'perl(Pod::AsciiDoctor)' git-core
git clone https://github.com/os-autoinst/openQA
cd openQA
sudo gem install asciidoctor pygments.rb
tools/ci/build-docs

Please note that tools/generate-docs script is not used at all in CirleCI context, there is tools/ci/build-docs as the main entry point which is invoking tools/generate-documentation.

That was more to @okurz, as he was pointing to the wrong place

Since it was already present before that pr was merged; My money is that something changed for the PDF generation, and asciidoctor-pdf is not available anymore. At this point, we could rely on the HTML-only format and remove the need for distributing a PDF.

Nope, you lost your money. This has nothing to do with the asciidoctor-pdf directly, one of its dependencies (bigdecimal) needs to build a native extension and hence needs the ruby devel headers. See https://app.circleci.com/pipelines/github/os-autoinst/openQA/13086/workflows/c5beef2e-d0f1-4516-93cd-552ea903e83f/jobs/122001?invite=true#step-109-5806_87

Fetching: bigdecimal-3.1.6.gem (100%)
Building native extensions. This could take a while...
ERROR:  Error installing asciidoctor-pdf:
        ERROR: Failed to build gem native extension.

This is exacly my point @jbaier_cz, something changed with asciidoctor-pdf; I don't really need to split hairs here :P. And as mentioned, at this point, I think the pdf generation can be dropped altogether; less code to maintain after all, and no need to install exta gems (so only one workflow exists)

szarate wrote in #note-8:

This is exacly my point @jbaier_cz, something changed with asciidoctor-pdf; I don't really need to split hairs here :P. And as mentioned, at this point, I think the pdf generation can be dropped altogether; less code to maintain after all, and no need to install exta gems (so only one workflow exists)

No, I do not believe in transitivity in this case. Nothing changed in asciidoctor-pdf; someone made a new version of something which is used by asciidoctor-pdf (and the change itself is probably not even used)... but nevertheless that's not important, the problem was in the ruby stack, yes.

I agree that we should drop the PDF generation once the effort to fix it outweighs the effort to remove it. But unless we change the documentation format we still need the ruby stack and some gems, so it will be only a few gems less. Not a big code change.

jbaier_cz wrote in #note-9:

I agree that we should drop the PDF generation once the effort to fix it outweighs the effort to remove it. But unless we change the documentation format we still need the ruby stack and some gems, so it will be only a few gems less. Not a big code change.

The thing is we have two ways of documentation generation, i'd argue that the pdf generation for the openqa documentation (not the testapi) is not necessarily useful anymore (I can't even remember why I enabled it)

It is clear now and eventually, we can circle back to drop (the generation of documentation in a single pdf page) in favor of generating the documentation using just the Ruby stack (i.e no need for zypper in asciidoctor) and for os-autoinst (testapi) to keep using the Perl module to distribute with the package in case some user needs it.

After all, users don't seem to go through the PDF, but rather go through the HTML (IBM, and Gnome at least)