Switch CI to use GitHub Actions

[codecov[bot]]

Codecov Report

Merging #24 (51c27aa) into master (219ac18) will decrease coverage by 1.46%. The diff coverage is n/a.

:exclamation: Current head 51c27aa differs from pull request most recent head 71094d9. Consider uploading reports for the commit 71094d9 to get more accurate results

@@            Coverage Diff             @@
##           master      #24      +/-   ##
==========================================
- Coverage   32.46%   31.00%   -1.47%     
==========================================
  Files          21       21              
  Lines        6459     6338     -121     
==========================================
- Hits         2097     1965     -132     
- Misses       4362     4373      +11     

Impacted Files	Coverage Δ
gap/interact.gi	19.21% <0.00%> (-4.68%)	:arrow_down:
gap/general.gi	28.13% <0.00%> (-3.12%)	:arrow_down:
gap/streams.gi	70.37% <0.00%> (-2.97%)	:arrow_down:
gap/options.gi	54.64% <0.00%> (-2.40%)	:arrow_down:
gap/ace.gd	100.00% <0.00%> (ø)
gap/ace.gi	100.00% <0.00%> (ø)
gap/general.gd	100.00% <0.00%> (ø)
gap/options.gd	100.00% <0.00%> (ø)
src/util0.c	19.94% <0.00%> (+0.05%)	:arrow_up:
src/control.c	70.97% <0.00%> (+0.29%)	:arrow_up:
... and 1 more

[wilfwilson]

I have re-run the tests after updating the gap-actions/compile-documentation-for-packages action, and the 'Build manuals' job still fails, but I believe that is not the fault of the action.

I also get the same failure on my local machine. I believe it is caused because GAP no longer (as of https://github.com/gap-system/gap/commit/1653871a945eea6a67077968eef90c33868ea9f6 in stable-4.11 and https://github.com/gap-system/gap/commit/ef2f8fcd934028f62ccf716767e120b835fd112a in master) contains the file doc/mrabbrev.bib.

This also affects the cubefree package, as shown here: https://github.com/gap-packages/cubefree/actions/runs/720607908

[fingolfin]

Thanks. But weird, I still can't reproduce this locally, despite mrabbrev.bib being gone.

And good that you mention cubefree: because it actually passed that test yesterday, see https://github.com/gap-packages/cubefree/actions. Did perhaps something else change in the Github Action?

[wilfwilson]

The GitHub action passed yesterday because my PR for dealing with doc/make_doc hadn't been merged yet into gap-actions/compile-documentation-for-packaes. The previous behaviour (as exhibited in this run https://github.com/gap-packages/cubefree/runs/2273374598) was as follows:

• Load GAP and read the file makedoc.g
• The file does not exist, so GAP quits and doesn't do anything
• GitHub Actions tries to upload the artifacts, but since none exist, it doesn't actually do anything (there is a warning about that visible https://github.com/gap-packages/cubefree/actions/runs/720568938):

• No files were found with the provided path: ./doc/manual.pdf. No artifacts will be uploaded.

But despite not doing anything, no failure was caused - which is why it passed yesterday.

[wilfwilson]

To make this more robust in the future, the 'upload' action should probably be made to fail the job if no artifact is produced.

[fingolfin]

Ok thanks! Now I just have to figure out why it doesn't fail for me locally. Well, that and a fix

[wilfwilson]

What exit code do you get after running ./make_doc for ace/cubefree? Although, for me locally, the make_doc script produces a reasonable-looking PDF for cubefree, and a reasonable-looking DVI for ace (although no PDF), in both cases it gives an exit code of 2.

[wilfwilson]

(And if I put the mrabbrev.bib file back in <GAPROOT>/doc, ace produces a PDF, and both packages return 0 after running make_doc).

Probably for both packages, the reference to mrabbrev.bib in manual.tex can simply be removed.

[wilfwilson]

Unfortunately it now fails because it tries to include the GAP file manualbib.xml.bib, which I gather only is created when compiling the GAP manuals. It uses this file for three bibitems (which already are almost exactly duplicated in ace's doc/manual.bib, albeit commented out).

I see a couple of ways to proceed:

• gap-actions/compile-documentation-for-packages could have an option that compiles the GAP manuals before compiling the package manuals (ultimately, we could provide a GAP docker image with pre-compiled manuals).
• Remove the inclusion of manualbib.xml.bib in ace, and instead reinstate the three bibitems in ace's manual.bib.

[fingolfin]

I'll remove the use of manualbib.xml.bib