Skip to content

Add CI job to check internal links#355

Merged
zuiderkwast merged 2 commits intovalkey-io:mainfrom
zuiderkwast:check-links-ci
Sep 4, 2025
Merged

Add CI job to check internal links#355
zuiderkwast merged 2 commits intovalkey-io:mainfrom
zuiderkwast:check-links-ci

Conversation

@zuiderkwast
Copy link
Contributor

Several broken links have found their way into our docs. Some of them work on the website, but not in locally build HTML and man pages.

The links need to be relative and point to the .md files, as explained in the README of this repo.

@zuiderkwast zuiderkwast force-pushed the check-links-ci branch 3 times, most recently from cffa6d4 to 9732b40 Compare September 4, 2025 13:57
Signed-off-by: Viktor Söderqvist <[email protected]>
Signed-off-by: Viktor Söderqvist <[email protected]>
@zuiderkwast
Copy link
Contributor Author

The first commit adds the checker. The second commit fixes the reported problems.

Without the second commit, the link checker reports these problems:

Run ./utils/check-links.pl
./topics/command-tips.md:6: Broken link: ../command.md
./topics/command-tips.md:14: Broken link: ../command.md
./topics/ldap.md:82: Broken link: ../acl
./topics/quickstart.md:115: Broken link: ../topics
./topics/quickstart.md:115: Broken link: ../commands
./topics/search.md:15: Link with absolute path: /topics/hashes
./topics/search.md:15: Link with absolute path: /topics/valkey-json
./topics/search.md:41: Link with absolute path: /commands/
./topics/valkey-bundle.md:13: Link with absolute path: /topics/valkey-json/
./topics/valkey-bundle.md:14: Link with absolute path: /topics/bloomfilters/
./topics/valkey-bundle.md:15: Link with absolute path: /topics/search/
./topics/valkey-bundle.md:16: Link with absolute path: /topics/ldap/
./topics/valkey-bundle.md:239: Link with absolute path: /topics/valkey.conf/
./topics/valkey-bundle.md:253: Link with absolute path: /topics/valkey-json/
./topics/valkey-bundle.md:254: Link with absolute path: /topics/bloomfilters/
./topics/valkey-bundle.md:255: Link with absolute path: /topics/search/
./topics/valkey-bundle.md:256: Link with absolute path: /topics/ldap/
./commands/sort.md:116: Broken link: acl_setuser.md
---
Internal absolute links  : 12
Internal broken links    : 6
Links to generated pages : 33
Links to existing pages  : 632
External links           : 219
Orphan pages             : 1
---
Links to generated pages (not in this repo):
[ 5] clients/
[26] commands/
[ 1] modules/
[ 1] topics/
---
Orphans:
  topics/index.md
---
Error: Process completed with exit code 1.

https://github.com/valkey-io/valkey-doc/actions/runs/17466417432/job/49603225912?pr=355

@zuiderkwast zuiderkwast marked this pull request as ready for review September 4, 2025 14:15
@zuiderkwast zuiderkwast requested a review from ranshid September 4, 2025 14:15
Copy link
Member

@ranshid ranshid left a comment

Choose a reason for hiding this comment

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

awesome!! so we had a link check set in place but we did not have a workflow validation. Great addition!

Copy link
Member

@madolson madolson left a comment

Choose a reason for hiding this comment

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

For some reason I thought this was already running, nice catch!

@zuiderkwast zuiderkwast merged commit 5d2f1e2 into valkey-io:main Sep 4, 2025
5 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.

3 participants