serokell / xrefcheck

Check cross-references in repository documents
Mozilla Public License 2.0
51 stars 3 forks source link

[#242] No scan symlinks as md files #261

Closed aeqz closed 1 year ago

aeqz commented 1 year ago

Problem: when the repository contains a symlink to a markdown file, it is processed by xrefcheck as if it was the same markdown file but in the symlink's location. This leads to broken references and can be avoided because neither GitHub nor GitLab try to render symlinks as the file they point to.

Solution: consider symlinks as no scannable files. In the future, we will consider to include a new dedicated scanner for symlinks if it works.

Related issue(s)

Fixes #242 Relates #244

:white_check_mark: Checklist for your Pull Request

Related changes (conditional)

Stylistic guide (mandatory)

aeqz commented 1 year ago

After several attempts on where to ignore symlinks, I have implemented the simplest one and we will complicate it in a following PR for #244 if necessary.