Skip to content

Lychee link check: drop artifact upload, prompt docs-agent in thread#1320

Merged
dslovinsky merged 3 commits into
mainfrom
ds/lychee-adjustments
May 21, 2026
Merged

Lychee link check: drop artifact upload, prompt docs-agent in thread#1320
dslovinsky merged 3 commits into
mainfrom
ds/lychee-adjustments

Conversation

@dslovinsky
Copy link
Copy Markdown
Collaborator

@dslovinsky dslovinsky commented May 21, 2026

Summary

Two follow-ups to #1317 (the weekly Lychee cron):

  • Drop the artifact upload. The Slack thread already holds every broken link with full context (URL + status code + lychee reason) and the 30k-char thread budget fits ~200+ failures comfortably. The GitHub Actions artifact was a fallback that nobody needed — easy to re-run the workflow if a regeneration is required. Truncation message in the script updated to point at re-running the workflow instead of the (now absent) artifact.
  • Prompt @docs-agent in the thread reply. At the bottom of the thread message, after the nested-bullet error list, we now tag the docs-agent bot with a brief triage prompt: update wrong-page links on domains we control, replace dead pages with the best current equivalent, and add exclude entries to lychee.toml for third-party domains that block bots. Each error sub-bullet now includes the lychee status text alongside the code so the agent has the reason for failure.

Test plan

  • Manually trigger the workflow (gh workflow run "Scheduled link check") after merge.
  • Confirm the channel post in #dx-developer-relations is unchanged from the first run.
  • Confirm the threaded reply now ends with the @docs-agent mention + triage prompt and triggers a real notification on the bot (not just plain text).
  • Confirm no broken-links artifact is attached to the run.

🤖 Generated with Claude Code

Adds a triage prompt addressed to the @docs-agent Slack bot at the
bottom of the thread message, with the broken-link list above it so
the agent has full context (URL + status code + lychee reason) when
deciding whether to fix the link, replace it, or add a bot-block
exception to lychee.toml.

Also removes the now-redundant artifact upload step: the thread
message holds all the info anyone needs to triage, and 30k chars fits
~200+ failures comfortably. Truncation message updated to point at
re-running the workflow instead of the (now absent) artifact.

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 21, 2026

🔗 Preview Mode

Name Status Preview Updated (UTC)
Alchemy Docs ✅ Ready 🔗 Visit Preview May 21, 2026, 7:52 PM

Three-level nesting (file → URL → reason) reads cleaner than the
inline em-dash variant when the reason text is long.

Co-Authored-By: Claude <noreply@anthropic.com>
@dslovinsky dslovinsky marked this pull request as ready for review May 21, 2026 19:51
@dslovinsky dslovinsky requested a review from a team as a code owner May 21, 2026 19:51
@dslovinsky dslovinsky merged commit 1701785 into main May 21, 2026
13 checks passed
@dslovinsky dslovinsky deleted the ds/lychee-adjustments branch May 21, 2026 19:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants