[#242] No scan symlinks as md files #261
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aeqz
force-pushed
the
aeqz/#242-no-scan-symlinks-as-md
branch
from
ff20ef4 to
b68920f
Compare
|
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. |
aeqz
force-pushed
the
aeqz/#242-no-scan-symlinks-as-md
branch
from
b68920f to
609282a
Compare
This was referenced Dec 30, 2022
Merged
Martoon-00
reviewed
Jan 12, 2023
| @@ -44,10 +44,11 @@ Unreleased | |||
| * [#254](https://github.com/serokell/xrefcheck/pull/254) | |||
| + Now the `dump-config` command does not overwrite a file unless explicitly told with a | |||
| `--force` flag. Also, a `--stdout` flag allows to print the config to stdout instead. | |||
| the configured Markdown flavour. | |||
There was a problem hiding this comment.
That's a good change 👍
And I would like it to be placed to a different commit 😸
There was a problem hiding this comment.
And the addition below should probably belong to the main commit )
Also, I would add a description to that commit you extracted after all. At a first glance, it's not clear why exactly you delete this line, maybe it was meant to contain some important information and should be extended, not removed. If in the commit description you mention that this was an accidental copy-paste, that would make the reasoning much clearer for an arbitrary git history reader.
YuriRomanowski
approved these changes
Jan 12, 2023
aeqz
force-pushed
the
aeqz/#242-no-scan-symlinks-as-md
branch
from
609282a to
066da26
Compare
Martoon-00
reviewed
Jan 12, 2023
Martoon-00
reviewed
Jan 12, 2023
aeqz
force-pushed
the
aeqz/#242-no-scan-symlinks-as-md
branch
from
066da26 to
1431587
Compare
aeqz
force-pushed
the
aeqz/#242-no-scan-symlinks-as-md
branch
from
1431587 to
e45ebd8
Compare
Problem: There is a duplicated line in the changelog unreleased section, which seems to be an accidental copy-paste typo or a bad merge conflict resolution. Solution: Delete the aforementioned changelog line.
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.
aeqz
force-pushed
the
aeqz/#242-no-scan-symlinks-as-md
branch
from
e45ebd8 to
fef5153
Compare
Martoon-00
approved these changes
Jan 19, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
✅ Checklist for your Pull Request
Related changes (conditional)
Tests
silently reappearing again.
Documentation
Public contracts
of Public Contracts policy.
and
Stylistic guide (mandatory)