Skip to content

Workflow changes to add automated link checking#428

Merged
TimHess merged 18 commits into
mainfrom
copilot/update-workflow-file-feedback
Mar 3, 2026
Merged

Workflow changes to add automated link checking#428
TimHess merged 18 commits into
mainfrom
copilot/update-workflow-file-feedback

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 23, 2026

Use lychee to add a broken external link checker workflow. Also addresses all workflow-related review feedback from PR #424.

check-links.yml (new)

  • Triggers on pull_request (paths: **.md, docs/**, and the workflow file itself) and workflow_dispatch
  • Posts/updates a single PR comment with results; job summary only when run manually — no issue management
  • Excludes: localhost, fortuneservice, *.internal, consul-register-example, docker://; paths .git, docs/api
  • --max-concurrency 5, --retry-wait-time 15, --max-retries 6, --timeout 30
  • Post-run steps use if: ${{ !cancelled() }}; lychee's built-in # Summary heading replaced with # Link checking results
  • Checkout step: name: Git checkout, persist-credentials: false

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: TimHess <3947063+TimHess@users.noreply.github.com>
Copilot AI changed the title [WIP] Update workflow file with feedback adjustments Add check-links workflow with all feedback from PR #424 applied Feb 23, 2026
Copilot AI requested a review from TimHess February 23, 2026 14:46
@TimHess TimHess changed the title Add check-links workflow with all feedback from PR #424 applied Add check-links workflow Feb 23, 2026
…and-stage.yml

Co-authored-by: TimHess <3947063+TimHess@users.noreply.github.com>
Copilot AI changed the title Add check-links workflow Add check-links workflow with all review feedback addressed Feb 23, 2026
@github-actions

This comment was marked as outdated.

@TimHess TimHess requested a review from bart-vmware February 23, 2026 16:33
@github-actions
Copy link
Copy Markdown

Preview link: https://www-steeltoe-pr-428.azurewebsites.net

  • Your changes have been deployed to the preview site. The preview site will update as you add more commits to this branch.
  • The preview link is shareable, but will be deleted when the pull request is merged or closed.

This is an automated message.

@TimHess TimHess changed the title Add check-links workflow with all review feedback addressed Workflow changes to add automated link checking Feb 23, 2026
…cfx files

- ignore razor routes from static file checking
- alter root-dir to avoid errors with asset links
- drop changes to build-and-stage
- replace .ps1 with equivalent of check-links.yml
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Feb 24, 2026

External link checking results

Status Count
🔍 Total 1922
✅ Successful 1056
⏳ Timeouts 0
🔀 Redirected 0
👻 Excluded 804
❓ Unknown 0
🚫 Errors 62
⛔ Unsupported 0

Errors per input

Errors in docs/api/v2/index.md

Errors in docs/api/v3/index.md

Errors in docs/api/v4/index.md

Errors in docs/articles/create-dotnet-microservice-projects-automatically-with-steeltoe-initializr.md

Errors in docs/articles/releases/steeltoe-2-2-gives-your--microservices-a-boost.md

Errors in docs/articles/releases/steeltoe-3-0-packs-a-mighty-punch-with-many-new-features.md

Errors in docs/articles/tech-tutorial-use-kubernetes-for-modern-net-apps-steeltoe-and-project-tye-are-your-path-to-productivity.md

Errors in docs/docs/v2/connectors/gemfire.md

Errors in docs/docs/v2/connectors/mysql.md

Errors in docs/docs/v2/connectors/redis.md

Errors in docs/docs/v2/logging/dynamic-logging-provider.md

Errors in docs/docs/v2/management/metrics.md

Errors in docs/docs/v2/management/using-endpoints.md

Errors in docs/docs/v2/security/credhub-api-client.md

Errors in docs/docs/v2/security/jwt-authentication-in-asp.NET-WebAPI.md

Errors in docs/docs/v2/security/sso-open-id.md

Errors in docs/docs/v3/configuration/config-server-provider.md

Errors in docs/docs/v3/configuration/kubernetes-providers.md

Errors in docs/docs/v3/connectors/mysql.md

Errors in docs/docs/v3/connectors/redis.md

Errors in docs/docs/v3/discovery/kubernetes.md

Errors in docs/docs/v3/discovery/netflix-eureka.md

Errors in docs/docs/v3/logging/dynamic-logging-provider.md

Errors in docs/docs/v3/messaging/rabbitmq-reference.md

Errors in docs/docs/v3/security/credhub-api-client.md

Errors in docs/docs/v3/stream/index.md

Errors in docs/docs/v3/stream/rabbit-binder.md

Errors in docs/docs/v4/connectors/cosmosdb.md

Errors in docs/docs/v4/connectors/mysql.md

Errors in docs/docs/v4/connectors/postgresql.md

Errors in docs/docs/v4/discovery/initialize-discovery-client.md

Errors in docs/docs/v4/fileshares/index.md

Errors in docs/docs/v4/management/cloud-foundry.md

Errors in docs/docs/v4/management/loggers.md

Errors in docs/docs/v4/management/prometheus.md

Errors in docs/guides/messaging/Tutorials/Tutorial1/Readme.md

Errors in docs/guides/messaging/Tutorials/Tutorial5/Readme.md

Errors in docs/guides/observability/wavefront.md

Full Github Actions output

@TimHess TimHess marked this pull request as ready for review February 25, 2026 15:25
Comment thread .github/workflows/check-links.yml
Comment thread .github/workflows/check-links.yml
Comment thread .github/workflows/check-links.yml Outdated
Comment thread .github/workflows/check-links.yml
Comment thread .gitignore
Comment thread .github/workflows/check-links.yml Outdated
Comment thread .github/workflows/check-links.yml Outdated
Comment thread .github/workflows/check-links.yml Outdated
Comment thread .github/workflows/check-links.yml Outdated
Comment thread build/check-external-links.ps1 Outdated
@bart-vmware

This comment was marked as resolved.

TimHess and others added 2 commits February 26, 2026 08:18
Co-authored-by: Bart Koelman <104792814+bart-vmware@users.noreply.github.com>
- only use --no-progress in CI
- use more defaults
- change settings per-host instead of globally
- check for installed lychee first
@TimHess

This comment was marked as resolved.

--verbose is needed to see redirect details
- locally:
  - set user-agent locally to avoid 403 on mysql links (doesn't seem to affect CI)
  - ignore build/docfx-net10-binaries (like playwright readme)
- longer host-request-interval and retry-wait-time
@TimHess TimHess requested a review from bart-vmware February 26, 2026 21:31
Comment thread .github/workflows/check-links.yml Outdated
- since redirect fixes are already in place in other PR, change verbosity now
@TimHess TimHess requested a review from bart-vmware February 27, 2026 16:25
- also include a paste-able snippet to bust the cache for a given PR
Comment thread .github/workflows/check-links.yml Outdated
Comment thread .github/workflows/check-links.yml Outdated
Comment thread .github/workflows/check-links.yml Outdated
Co-authored-by: Bart Koelman <104792814+bart-vmware@users.noreply.github.com>
@TimHess TimHess requested a review from bart-vmware March 2, 2026 13:52
@TimHess TimHess merged commit 0c87328 into main Mar 3, 2026
4 checks passed
@TimHess TimHess deleted the copilot/update-workflow-file-feedback branch March 3, 2026 14:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants