Skip to content

docs(agents): describe the CI link check and scan in one place #325

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
altaywtf merged 1 commit into from
Oct 5, 2026
Merged

docs(agents): describe the CI link check and scan in one place #325

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ that matches. Report skipped or unavailable proof.

| Change | Proof |
| ----------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| Docs only | `./gradlew markdownCheck`; check the links and commands you touched. Pull-request CI runs only `Check Markdown` |
| Docs only | `./gradlew markdownCheck`; check web links and commands. Pull-request CI checks relative links, skips builds |
| Domain or core logic | `./gradlew :domain:<name>:testDebugUnitTest` or `:core:<name>:testDebugUnitTest`; tests live in the owning module |
| App view models or services | `./gradlew :mobile:testProductionDebugUnitTest` or `:tv:testProductionDebugUnitTest` |
| UI, navigation, playback, or launch | The affected flow on the emulator: `./scripts/prove.sh <mobile\|tv>` or its lane in [Harness](docs/harness.md) |
Expand All @@ -149,21 +149,21 @@ runs `verify` with them excluded plus the debug assembles. When either command
changes, compare their `--dry-run` task lists with the full command's; together
they must run exactly the same tasks. A pull request that changes Markdown also
runs `Check Markdown` (`./gradlew markdownCheck`), so docs-only changes still
get the formatting check. `Detect code changes` runs on every event and
checks relative Markdown links and anchors offline. CI holds no secrets and keeps
failed unit-test XML as the `failed-unit-test-reports` artifact. A new push to
a pull request cancels its running check; `main` runs never replace each other.
get the formatting check. CI holds no secrets and keeps failed unit-test XML as
the `failed-unit-test-reports` artifact. A new push to a pull request cancels
its running check; `main` runs never replace each other.

`Detect code changes` runs on every event. It checks relative Markdown links and
anchors offline, then runs the shared put.io scan: on a `main` push, Actionlint
and Zizmor audit `.github/` when the pushed range changes it, and a manual
dispatch of CI audits every workflow. GitHub secret scanning and push
protection catch secrets at push time.

[Emulator smoke](.github/workflows/emulator-smoke.yml) runs `LaunchSmokeTest`
and `StaleOAuthCallbackTest` on a Gradle Managed Device weekly and on dispatch.
It is not a pull-request gate because shared-runner emulator boots are too slow
and flaky; `scripts/prove.sh` stays the local proof.

`Detect code changes` also runs the shared put.io scan on each `main` push:
Actionlint and Zizmor audit `.github/` when the pushed range changes it, and a
manual dispatch of CI audits every workflow. GitHub secret scanning and push
protection catch secrets at push time.

To reproduce a CI failure, check out the app SHA from the run summary in a
detached worktree with `sdk.dir` set and `putioSdkKotlinPath` unset, then run
the same command. A pull-request run tests a temporary merge commit; if it is
Expand Down