ci: run link checker on PRs

[patrick-stephens]

Set up CI to run link checker on PRs but also manually if required - manual runs will create an issue but PRs will only generate a report on the job when it is run.
Fixed a few redirects and excluded some others.
We do not fail on error as quite often these are timeout, bot detection and other errors.

Summary by CodeRabbit

• Chores

  • Improved automated link checking for pull requests and scheduled runs.
  • Scheduled checks can create issues when broken links are detected.
  • Excluded known non-checkable pages from automated link validation.

• Documentation

  • Updated source download, Dynatrace, Amazon ECR Public, Docker, and RFC reference links to current destinations.
  • Clarified Docker as the container runtime requirement in the tutorial.

[coderabbitai]

Warning

Review limit reached

@patrick-stephens, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 37 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 05bdcc23-2a84-46e2-9b85-2911c0d3db45

📥 Commits

Reviewing files that changed from the base of the PR and between 3d57174 and dcec6c6.

📒 Files selected for processing (1)

• scripts/run-link-checker.sh

📝 Walkthrough

Walkthrough

The link-check workflow now separates pull-request and scheduled checks. It uses explicit permissions and shared Lychee arguments. Several documentation links are updated, and selected URLs are excluded from link checking.

Changes

Link check workflow and documentation links

Layer / File(s)	Summary
Workflow triggers and failure handling .github/workflows/linkcheck.yaml	The workflow adds manual, scheduled, and pull-request triggers. Pull-request checks use read-only contents access. Scheduled checks can create issues after Lychee reports a failure.
Link targets and ignore rules .lycheeignore, installation/downloads/source.md, pipeline/outputs/dynatrace.md, pipeline/outputs/kinesis.md, administration/transport-security.md, pipeline/outputs/s3.md, stream-processing/tutorial.md	The change adds ignored URL patterns and updates source download, Dynatrace, Amazon ECR Public, RFC 6066, and Docker Engine links.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested labels: 5.1

Suggested reviewers: eschabell, cosmo0920

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly summarizes the main change: configuring CI to run the link checker on pull requests.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch ci_run_linkcheck_on_prs

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/workflows/linkcheck.yaml:
- Around line 11-14: Split the link-check workflow into separate pull-request
and scheduled jobs: keep the pull-request job limited to contents: read, and
move the issue-creation flow using peter-evans/create-issue-from-file into a
scheduled job with issues: write. Preserve the existing link-check behavior
while ensuring the write permission is unavailable during pull-request runs.

🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 9137fc17-ff64-47eb-b0db-dbefc4d92224

📥 Commits

Reviewing files that changed from the base of the PR and between b476255 and 0415036.

📒 Files selected for processing (1)

• .github/workflows/linkcheck.yaml

[patrick-stephens]

Looks like there are already some failures so will switch to not failing but we still get the report each time anyway.

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/workflows/linkcheck.yaml:
- Line 23: Update both checkout steps in the workflow jobs to set
persist-credentials to false, ensuring neither job retains the checkout token
for subsequent Git operations while preserving the pinned actions/checkout
versions.

In `@stream-processing/tutorial.md`:
- Line 10: Update the prerequisite entry to explicitly require Docker Engine and
the Docker CLI, replacing the generic “container runtime” wording. Change the
Docker homepage link to Docker’s technical Engine documentation page, keeping
the prerequisite language technical and neutral.

🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: fbc7fa07-e271-4a31-8231-1847f04bbcbb

📥 Commits

Reviewing files that changed from the base of the PR and between 0415036 and 9033a9a.

📒 Files selected for processing (6)

• .github/workflows/linkcheck.yaml
• .lycheeignore
• installation/downloads/source.md
• pipeline/outputs/dynatrace.md
• pipeline/outputs/kinesis.md
• stream-processing/tutorial.md

[patrick-stephens]

@eschabell ready for review.