🌱 Remove legacy typo and link checker workflows#617
🌱 Remove legacy typo and link checker workflows#617clubanderson wants to merge 1 commit intomainfrom
Conversation
|
🚨 Unsigned commits detected! Please sign your commits. For instructions on how to set up GPG/SSH signing and verify your commits, please see GitHub Documentation. |
There was a problem hiding this comment.
Pull request overview
This PR removes two legacy GitHub Actions workflows for typo checking and markdown link validation. These workflows are being replaced by centrally deployed AI-powered agentic workflows (typo-checker.md and link-checker.md) in the llm-d-infra repository, as part of a broader modernization effort.
Changes:
- Removed the
check-typos.yamlworkflow that used the crate-ci/typos action - Removed the
md-link-check.ymlworkflow that used the lycheeverse/lychee-action
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
.github/workflows/md-link-check.yml |
Removes markdown link checker workflow that validated links in documentation |
.github/workflows/check-typos.yaml |
Removes typo checking workflow that scanned codebase for spelling errors |
Comments suppressed due to low confidence (2)
.github/workflows/md-link-check.yml:1
- The
.lychee.tomlconfiguration file in the repository root is now orphaned since this workflow that used it is being removed. Consider removing.lychee.tomlas well, or document that it's retained for the centrally deployed agentic workflow in llm-d-infra if that's the intention.
.github/workflows/check-typos.yaml:1 - The
.typos.tomlconfiguration file in the repository root is now orphaned since this workflow that used it is being removed. Consider removing.typos.tomlas well, or document that it's retained for the centrally deployed agentic workflow in llm-d-infra if that's the intention.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
f705c8a to
1009370
Compare
ea40901 to
67f52f5
Compare
elevran
left a comment
There was a problem hiding this comment.
Thanks for the PR. A few high level comments:
- kndly request to not open branches on this repo for PR's - use a fork instead. Will close this branch in a couple of days so you have time to move the changes over.
- please clarify the benefit of "agentic workflows" for tasks that can be handled by regualr tool calling and would produce consistent/repeatable results (unlike LLMs).
- there are some issues recently open on the repo (#621 #622 #623 #630) which seem related to the use of agentic PRs. Can you please clarify what value they provide beyond what's already reported on the issue itself (pass/fail and comments)? These would cause excessive GH notifications and emails on watched repos for each PR run. I expect agentic workflows, when run, to report directly on the PRs and not manage their own issues to track runs.
.github/workflows/check-typos.yaml
Outdated
There was a problem hiding this comment.
Please do not delete this file. We would like to keep running the "legacy" typos check as default, possibly monitoring how the "agentic" one performs so we can make an informed decision.
There was a problem hiding this comment.
For now I prefer not to have agentic workflows run for checks that can be just as well run with deterministic tools, so no need to setup Copilot tooling just yet.
There was a problem hiding this comment.
Q:
Do we need both the *.lock.yml file and the *.md that was used to create it in our repo?
Should we be importing actions from llm-d-infra instead of replicating the files?
There was a problem hiding this comment.
This applies to all agentic workflows in the PR
| @@ -0,0 +1,130 @@ | |||
| --- | |||
| description: | | |||
There was a problem hiding this comment.
Can you please clarify the value that you expect from running LLM to check links and/or typos, actions that can be done by deterministic tooling with equal or better success?
Since LLM output depends on prompt and is also subject to hallucenations or statistical variance, we don't want testing flakes introduced by multiple LLM runs.
| - **Internal links**: verify the target file exists in the repo using `ls` or `test -f` | ||
| - **Anchor links**: verify the heading exists in the target file | ||
| - **External links**: use `curl -sL -o /dev/null -w '%{http_code}' --max-time 10` to check | ||
| - For external URLs that return 4xx: mark as **definitely broken** |
There was a problem hiding this comment.
what about 3xx errors (e.g., moved permanently, found, ...)?
There was a problem hiding this comment.
unclear how's this file change is related
.lychee.toml
Outdated
There was a problem hiding this comment.
ditto - should not be deleted unless we move to agentic flows.
.typos.toml
Outdated
| @@ -1,17 +0,0 @@ | |||
| [default.extend-words] | |||
There was a problem hiding this comment.
Are the below words and file types exception supported in the new wrokflows?
They should support per repo configurations.
There was a problem hiding this comment.
are the go.mod/sum changes related to this PR?
|
nit: there seems to be a duplicate signoff message on commits: |
8bf42c1 to
d53d7c3
Compare
Remove orphaned workflow caller files that referenced deleted reusable workflows from llm-d-infra Signed-off-by: Andy Anderson <andy@clubanderson.com>
d53d7c3 to
ed0c98e
Compare
Consolidated PR replacing llm-d#616 and llm-d#617. Governance & tooling standardization: - Simplify all governance workflows to use reusable patterns - Add .pre-commit-config.yaml with standard hooks - Update Dockerfiles and Makefile.tools.mk - Update go.mod/go.sum dependencies - Standardize test imports Legacy CI cleanup: - Remove check-typos.yaml and md-link-check.yml (replaced by pre-commit) - Remove orphaned .lychee.toml and .typos.toml configs Agentic workflows: - Add typo-checker, link-checker, and upstream-monitor agentic workflows - Add copilot-setup-steps and actions-lock config - Add upstream-versions tracking doc Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: Andrew Anderson <andy@clubanderson.com>
Consolidated PR replacing llm-d#616 and llm-d#617. Governance & tooling standardization: - Simplify all governance workflows to use reusable patterns - Add .pre-commit-config.yaml with standard hooks - Update Dockerfiles and Makefile.tools.mk - Update go.mod/go.sum dependencies - Standardize test imports Legacy CI cleanup: - Remove check-typos.yaml and md-link-check.yml (replaced by pre-commit) - Remove orphaned .lychee.toml and .typos.toml configs Agentic workflows: - Add typo-checker, link-checker, and upstream-monitor agentic workflows - Add copilot-setup-steps and actions-lock config - Add upstream-versions tracking doc Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: Andrew Anderson <andy@clubanderson.com>
Summary
Removes the old
check-typos.yamland/ormd-link-check.ymlcaller workflows. These are replaced by AI-powered gh-aw agentic workflows (typo-checker.mdandlink-checker.md) deployed centrally in llm-d-infra.The reusable workflows in llm-d-infra are kept as legacy fallback.
Test plan
/cc @elevran @shmuelk