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.

Sign up for GitHub

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

Jump to bottom

ci: Add automated check for broken links #54

Open
thanethomson opened this issue Mar 4, 2023 · 1 comment
Open

ci: Add automated check for broken links #54

thanethomson opened this issue Mar 4, 2023 · 1 comment
Labels
ci

Comments

@thanethomson
Copy link
Contributor

Follow-up to #25.

We need a check that runs regularly in CI (e.g. at least once daily) that crawls all deployed versions (even those not accessible from the nav) of the docs site and notifies us of any broken links.

Failure of the workflow is sufficient notification for now.
@thanethomson thanethomson added the ci label Mar 4, 2023
@thanethomson thanethomson mentioned this issue Mar 4, 2023
Merged
3 tasks
mergify bot pushed a commit to cometbft/cometbft that referenced this issue Mar 6, 2023
@thanethomson
ci: Remove Markdown link checker (#455)
a2066cf 
Link checking will soon happen from the CometBFT docs repo, as per cometbft/cometbft-docs#54.

Already, the Jekyll build restructures the documentation, resulting in broken links in Markdown that will be correctly rendered only once deployed to the docs site (e.g. the `/spec` directory is moved into `/docs/spec`, and the `rpc/openapi/*` contents are moved into `/docs/rpc/` during the build for each version of the docs).

---

#### PR checklist

- [ ] Tests written/updated
- [ ] Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog)
- [ ] Updated relevant documentation (`docs/` or `spec/`) and code comments
@andynog
Copy link
Contributor

andynog commented Mar 20, 2023

I think it's a good idea. Should the notification be an email sent to the team ?

Also, there might be false positives in the report since the tool we use to check the broken links cannot detect things like URL fragments properly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
ci
Projects
No open projects
CometBFT 2023
Status: Todo
Milestone
No milestone
Development

No branches or pull requests
2 participants
@thanethomson @andynog