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

Updates to 404 checker in PR workflow #13874

Open
thoward opened this issue Jan 22, 2025 · 1 comment
Open

Updates to 404 checker in PR workflow #13874

thoward opened this issue Jan 22, 2025 · 1 comment
Assignees
Labels
area/docs Improvements or additions to documentation kind/engineering Work that is not visible to an external user kind/enhancement Improvements or new features
Milestone

Comments

@thoward
Copy link
Contributor

thoward commented Jan 22, 2025

Currently we have a 404 checker that looks for new broken links/missing pages, which happens before merge during the PR workflow. If this fails, it will block the merge of a PR. Unfortunately, while this tool often reports correctly, it also often reports incorrectly, causing problematic merge workflows. For that reason, we have temporarily disabled it in PR #13775 .

This task would be to update that workflow such that:

  • 404 checker is re-enabled
  • it does not block PR merge
  • instead, it runs similarly to our site previews (pre-merge) and reports results into the PR as a comment

With these changes, authors of PRs can get a signal from the 404 checker without it interrupting the workflow. An author can inspect each reported 404 link and fix any that are real issues, and ignore the ones that are false reports.

Later, we will invest in improving the accuracy of the checker and possibly restore it to a blocking part of the PR workflow, but these changes will allow us to get value from it without it interrupting productivity.

@thoward thoward added area/docs Improvements or additions to documentation kind/engineering Work that is not visible to an external user kind/enhancement Improvements or new features labels Jan 22, 2025
@github-project-automation github-project-automation bot moved this to 🤔 Triage in Docs 📚 Jan 22, 2025
@github-actions github-actions bot added the needs-triage Needs attention from the triage team label Jan 22, 2025
@thoward thoward removed the needs-triage Needs attention from the triage team label Jan 23, 2025
@ericrudder ericrudder added this to the 0.116 milestone Jan 28, 2025
@ericrudder
Copy link
Member

i think we should keep the behavior that blocks the PR merge .., that's the main idea of a hygiene gate like this.

let's make sure to get this re-enabled ASAP tho.

@thoward thoward moved this from 🤔 Triage to 🧳 Backlog in Docs 📚 Jan 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Improvements or additions to documentation kind/engineering Work that is not visible to an external user kind/enhancement Improvements or new features
Projects
Status: 🧳 Backlog
Development

No branches or pull requests

3 participants