Skip to content

🌱 Add structured CI-observability summary to check-internal-links.yml - #6802

Open
kubestellar-hive[bot] wants to merge 1 commit into
mainfrom
telemetry/check-internal-links-ci-summary
Open

🌱 Add structured CI-observability summary to check-internal-links.yml#6802
kubestellar-hive[bot] wants to merge 1 commit into
mainfrom
telemetry/check-internal-links-ci-summary

Conversation

@kubestellar-hive

Copy link
Copy Markdown
Contributor

Fixes #6801

What

scripts/check-internal-links.ts (run by check-internal-links.yml on every PR/push touching docs/content/**) only printed decorative free-text lines to stdout. There was no machine-readable summary and nothing written to $GITHUB_STEP_SUMMARY.

Change

  • Emit one grep-friendly, bounded-cardinality line: CI_OBSERVABILITY check=internal-links links_checked=<n> routes=<n> broken=<n> status=pass|fail. Only aggregate counts are included — no file paths or link targets (those stay in the existing free-text error detail, unbounded and only printed on failure as before).
  • Append a short markdown table to $GITHUB_STEP_SUMMARY when running in CI (no-op locally where the env var is unset).

This mirrors the CI-observability convention already used for vitest.yml/fuzz-mdx.yml in this repo.

Testing

  • npm run type-check — passes
  • npm run check-links (with GITHUB_STEP_SUMMARY set) — verified structured line + summary table output, 0 broken links
  • npx vitest run on the two existing helper test suites (97 tests) — all passing, unaffected by this change (no test coverage change needed; main() is only invoked when run as a script, unchanged from prior behavior)

No exporter, external data flow, or secrets introduced. CI-observability only.

— hive: agent=telemetry backend=copilot model=claude-sonnet-4-6

scripts/check-internal-links.ts only printed decorative free-text lines.
Emit one bounded, grep-friendly CI_OBSERVABILITY line (counts only, no
file paths or link targets) and a short markdown table to
$GITHUB_STEP_SUMMARY, matching the pattern already used for
vitest.yml/fuzz-mdx.yml.

Fixes #6801

Signed-off-by: kubestellar-hive[bot] <kubestellar-hive[bot]@users.noreply.github.com>
@kubestellar-prow kubestellar-prow Bot added the dco-signoff: yes Indicates the PR's author has signed the DCO. label Sep 8, 2026
@kubestellar-prow

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign clubanderson for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@netlify

netlify Bot commented Sep 8, 2026

Copy link
Copy Markdown

Deploy Preview for kubestellar-docs ready!

Name Link
🔨 Latest commit 9f812fc
🔍 Latest deploy log https://app.netlify.com/projects/kubestellar-docs/deploys/6a9fa03cddf48f00086031e2
😎 Deploy Preview https://deploy-preview-6802--kubestellar-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@kubestellar-prow

Copy link
Copy Markdown

Hi @kubestellar-hive[bot]. Thanks for your PR.

I'm waiting for a kubestellar member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@kubestellar-prow kubestellar-prow Bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 8, 2026
@kubestellar-hive kubestellar-hive Bot added the hold label Sep 8, 2026
@kubestellar-hive

Copy link
Copy Markdown
Contributor Author

Important

Held for human sign-off on the direction, not on the code.

This PR's only tracked rationale is #6801, which the hive filed itself — issue #6801 was filed by kubestellar-hive[bot] and no human has acknowledged it. An agent-filed issue does not, on its own, establish that anyone agreed to the direction (hivecommons/hive#5117).

The change may well be right; nothing here is a review of it. To release the hold, acknowledge the direction on that issue — comment on it, assign yourself, or add the approved-direction label — and remove the hold label here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

copilot dco-signoff: yes Indicates the PR's author has signed the DCO. hold needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. typescript

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[telemetry] check-internal-links.yml has no structured CI-observability summary

0 participants