Document CI workflows in README + workflows reference - #5107
Merged
Conversation
Add a Continuous integration section to the top-level README with a quick-reference table of all 13 GitHub Actions workflows (what each does, when it runs, and whether it blocks PRs), linking to a new .github/workflows/README.md that fully describes each workflow: purpose, triggers, blocking behavior, secrets, and known maintenance concerns. The reference also documents the shared Viam test-org dependency used by the scheduled code-sample and SDK-coverage jobs, and collects recurring maintenance themes (stale action versions, dead PR-automation logic, reliance on live external services) surfaced while reviewing the jobs. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
viambot
added
the
safe to build
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add a "TODO: repairs" section at the bottom of the workflows README with an actionable checklist for fixing the broken/degraded jobs: restoring failure visibility (the Jira notification steps), the test-code-samples test-org dependency and step isolation, the dead alias-reminder and pr-labeler logic, the check-methods signal, and the batchable action-version/cleanup items. Also close up spaced em/en dashes throughout the file to satisfy the Viam.DashesSpaces vale rule (level: error). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Nick Hehr (HipsterBrown)
approved these changes
Jun 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Documents the repo's GitHub Actions CI as part of an audit of the current jobs (prompted by the long-broken Test Code Samples job).
README.md— new Continuous integration section with a quick-reference table of all 13 workflows: what each does, when it runs, and whether it blocks PRs..github/workflows/README.md— new full reference: per-workflow purpose, triggers, blocking behavior, secrets, and known concerns; a description of the Python helper scripts; the shared Viam test-org dependency; and recurring maintenance themes.Docs only — no workflow behavior changes.
Job review summary
Reviewed all 13 workflows. Highlights for follow-up (captured in the reference):
Blocking PR checks:
vale-lint(prose),codespell,run-htmltest-local(internal links).markdown-lint,prettier-lint,python-lintare informational only (continue-on-error: true).Scheduled jobs (fail → Jira ticket, don't block):
test-code-snippets.yml— Mondays 09:00 UTC; runs Python/Go/TS samples against a live Viam org. Failing continuously since 2025-11-10 (Python step aborts Go/TS). Root cause: the test org has no roleless member forfleet-management-api-orgs.py. Tracked in Fix Test Code Samples: select a non-owner member in fleet-api orgs sample #5106.check-methods.yml— Wednesdays 10:00 UTC; scrapes SDK doc sites for API-method coverage. Job-levelcontinue-on-error: true, so its only failure signal is a Jira ticket.run-htmltest.yml— Tuesdays 10:00 UTC; external link check.Stale / dead logic worth a cleanup pass (not changed here):
checkout@v2/v3,setup-python@v4,github-script@v6); twowjdp/htmltest-action@mastermoving-branch pins.alias-reminder.ymluses disabled::set-output→ reminder never posts.pr-labeler.ymlgates onsynchronize/reopenedbut only subscribes toopened.vale-lint.yml/python-lint.ymlcarry dead Python-3.8 venv steps.Verification
prettier --checkandmarkdownlintpass on both files.make build-prodonly cover site content underdocs/; these are repo/.github/reference files, so those gates don't apply.🤖 Generated with Claude Code