Skip to content

Packages with broken reference in their manuals #6164

@fingolfin

Description

@fingolfin

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 gap-actions/build-pkg-docs#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:

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 gap-actions/build-pkg-docs#37

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    topic: documentationIssues and PRs related to documentationtopic: packagesissues or PRs related to package handling, or specific to a package (for packages w/o issue tracker)

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions