Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: check dead links and broken file references #1448

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

novusnota
Copy link
Member

@novusnota novusnota commented Jan 21, 2025

With careful separation of internal documentation and public Tact docs. And introduction of a scheduled workflow (once a week) that checks external (https) links and auto-creates issues when such checks fail.

Also, resolved issues with some links. For example, the Certik blogpost gives 403, i.e. automatic link scans are probably detected and prohibited — and thus it had to be added to exceptions. Since the CI args in the public docs case are already rather long, I've decided to make a .lycheeignore file and put that blogpost there.

Issue

Closes #755.

Checklist

  • I have run the linter, formatter and spellchecker
  • I did not do unrelated and/or undiscussed refactorings

With careful separation of internal documentation and public Tact docs
The Certik blogpost gives 403, i.e. automatic link scans are probably
detected and prohibited
@novusnota novusnota added this to the v1.6.0 milestone Jan 21, 2025
@novusnota novusnota requested a review from a team as a code owner January 21, 2025 01:21
@verytactical
Copy link
Contributor

In my opinion, CI shouldn't check external links. Third party services are often going down, and we'll have to fix every link before we'll be able to merge any PRs.

I'd rather keep it to only internal links, and create an optional or regular job for external links.

@novusnota novusnota changed the title ci: check dead links and broken file references in CI ci: check dead links and broken file references Jan 21, 2025
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.

Add broken links checker to CI
2 participants