Skip to content

Fix link checker#425

Merged
NicNomadic merged 3 commits intomainfrom
fix-link-checker
Mar 23, 2026
Merged

Fix link checker#425
NicNomadic merged 3 commits intomainfrom
fix-link-checker

Conversation

@NicNomadic
Copy link
Copy Markdown
Collaborator

@NicNomadic NicNomadic commented Mar 19, 2026

After merging #414 the test reports are available in the Checks tab for image links and such, but not for external links.
For the latter, the test is done, but the results are not included in the Mocha report.

See https://github.com/etherlinkcom/docs/actions/runs/21404745598 for an example of incomplete Mocha report containing results for: image links, proposed dependencies, and (un)used images, but excluding external links. The latter are however tested as can be seen by clicking on tests in the left menu, taking you to https://github.com/etherlinkcom/docs/actions/runs/21404745598/job/61625369537 where you can see that external link tests have been run, along the tests for image links, proposed dependencies, and (un)used images.

I assume the external links results are missing because their result is not within the doclib/ folder from which artifacts are saved, but rather in the parent directory; this is unlike the other artifact, that are saved correctly.

Solution: move the external link report under doclib/, like for all the other tests.

Test: push a dummy commit changes a text page to trigger the tests, and compare the Mocha report (https://github.com/etherlinkcom/docs/actions/runs/23351152225) to the example above.
See that there is a new table doclib/externalinks.xml.

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 19, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs-etherlink Ready Ready Preview, Comment Mar 20, 2026 5:37pm

Request Review

Copy link
Copy Markdown
Collaborator Author

@NicNomadic NicNomadic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review from Copilot:

Summary

This PR addresses an issue where external link test results weren't appearing in the Mocha report after PR #414 was merged. The fix is straightforward and logical.

Key Changes

The single file modified is .github/workflows/pr-tests.yml. The main change:

External link and anchor check step:

Before: mochaFile=../externalLinks.xml (output to parent directory)
After: mochaFile=externalLinks.xml (output to doclib directory)
This aligns the external link report path with the other test artifacts (image links, unused images, dependency proposer), which are all now consistently saved within the doclib/ folder.

Additional Improvements

The PR also includes minor formatting fixes (adding spaces before pipes ||):

Line 55: imageLinks.xml|| → imageLinks.xml ||
Line 59: usedImages.xml|| → usedImages.xml ||
Line 63: proposedDependencies.xml|| → proposedDependencies.xml ||
These are style improvements for consistency.

Assessment

✅ Strengths:

Clear, focused fix targeting the exact problem
Well-explained in the PR description
Maintains consistency with artifact storage paths
Changes are minimal and low-risk
✅ Status:

Currently blocked for merging (likely awaiting reviews or checks)
2 commits, 1 file changed
4 additions, 4 deletions
Recommendation

This PR looks good to merge. The fix is straightforward, addresses the reported issue directly, and the additional formatting changes improve code consistency. Once any blocking checks pass and reviews are approved, this should be safe to merge.

Copy link
Copy Markdown
Collaborator

@charles-nl charles-nl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems needed

@NicNomadic NicNomadic merged commit baee505 into main Mar 23, 2026
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants