gap icon indicating copy to clipboard operation
gap copied to clipboard

Packages with broken reference in their manuals

Open fingolfin opened this issue 3 months ago • 2 comments

Unfortunately we missed something when migrating from ReleaseTools to gap-actions/release-pkg: namely ReleaseTools used to do PushOptions(rec(relativePath:="../../..")) to ensure AutoDoc forces GAPDoc to produce relative links to other package manuals and to the GAP manuals.

We forgot to do the same in the new system -- this has now been fixed in https://github.com/gap-actions/build-pkg-docs/pull/35 but unfortunately several packages had releases with this problem.

However, several packages had releases affected by this (and thus now have links of the form <a href="/home/runner/gap/... in their HTML). These now need new releases to fix their manuals. These packages are affected in their current version:

  • [ ] autodoc
  • [ ] datastructures
  • [ ] digraphs (CC @wilfwilson @james-d-mitchell)
  • [ ] ferret (CC @ChrisJefferson)
  • [ ] fplsa
  • [ ] primgrp
  • [x] smallclassnr (CC @stertooy)
  • [x] twistedconjugacy
  • [x] utils (CC @cdwensley)
  • [ ] wedderga

For reference I found the above list via this command, where pkg contained a fresh copy of the package distribution

rg -l '/home/runner' pkg | cut -d/ -f1 | sort | uniq

In addition we should add extra validation to catch this problem during the release process; see https://github.com/gap-actions/build-pkg-docs/issues/37

Many thanks to Bill Allombert who noticed the problem and reported it to me.

fingolfin avatar Nov 13 '25 14:11 fingolfin

Utils 0.93 released.

cdwensley avatar Nov 13 '25 15:11 cdwensley

smallclassnr and twistedconjugacy both have a new release.

stertooy avatar Nov 14 '25 12:11 stertooy