Add recording how to run openQA test in 5 minutes

[baierjan]

Add scenario for asciinema recording and include it into documentation.

Add Dockerfile and a short Makefile to allow generating GIFs out of autocast yaml files with the asciicast + agg combo without installing anything. The cast will be done inside the container as well, so the recording is done isolated from the rest of the system.

Reference: https://progress.opensuse.org/issues/76978

[github-actions]

Great PR! Please pay attention to the following items before merging:

Files matching docs/*.asciidoc:

• Consider generating documentation locally to verify it is rendered correctly using tools/generate-docs

This is an automatically generated QA checklist based on modified files.

[kalikiana]

Neat

[Martchus]

Adding 5.5 MiB of binary data to our repo's master branch is maybe not so nice. It would be nice if we could offload the binary to the gh-pages branch (which has a completely separate chain of commits).

(I'm only requesting changes here so we have at least some time to discuss this. If you all think having 5.5 MiB on the master branch is ok then just dismiss my review. Otherwise the change looks good to merge.)

[baierjan]

Adding 5.5 MiB of binary data to our repo's master branch is maybe not so nice. It would be nice if we could offload the binary to the gh-pages branch (which has a completely separate chain of commits).

(I'm only requesting changes here so we have at least some time to discuss this. If you all think having 5.5 MiB on the master branch is ok then just dismiss my review. Otherwise the change looks good to merge.)

Yes, that is actually a very good point. Having a (rather large) gif file is more portable, but it makes the repo and also the page (which then loads a little bit slower). I was also thinking about using the .cast file and embed the asciicast javascript player into the documentation, but that would on the other hand introduce external dependency.

As we might be adding more of this later, we might want to have the optimal way to handle it. Do we have any convenient way how to use the gh-pages branch? I mean I can easily push the recording there but it would be then a little bit awkward to keep track if the version there is "in-sync" with the source in the main branch.

[baierjan]

I created #5616 which should include the recording directly into pages. The GIF is removed from this pull request and instead a gitignore is introduced to not accidentally push the recordings here. Will that work for you @Martchus ?

[perlpunk]

Where can I find a documentation of this file format? I searched https://docs.asciinema.org/ but could not find anything

[baierjan]

This yaml file is for https://github.com/k9withabone/autocast. The tool is briefly mentioned in the commit message (yes, it does not look like it). This makefile rule will then create a cast from it

openQA/docs/asciinema/Makefile

Lines 12 to 13 in f9fe556

	%.cast:%.yaml
	autocast --overwrite $< $@

[baierjan]

And this is where I was able to find it initially: https://docs.asciinema.org/integrations/?h=autocast