agentleFS
MicrosoftKnown publishermicrosoft/FluidFramework/.github/skills/ci-readiness-check/SKILL.md

ci-readiness-check

Skill4.9k starsChanged 3 months agoMITView on GitHub

Use when the user explicitly asks for a CI check or to push their branch — e.g. "ci readiness", "check ci", "pre-push check", "ready for CI", "ci check", "ready to push", "push my changes", "push the branch", "let's push". Catches common CI failures before pushing — formatting, stale API reports, missing changesets, policy violations.

Trending

Less talk lately.about the whole repository

Dec 2025: 0 mentionsJan 2026: 0 mentionsFeb 2026: 2 mentionsMar 2026: 5 mentionsApr 2026: 5 mentionsMay 2026: 3 mentionsJun 2026: 21 mentionsJul 2026: 1 mentionAug 2026: 0 mentionsSep 2026: 0 mentionsOct 2026: 2 mentionsNov 2026: 1 mention
Dec 2025Jun 2026Nov 2026
Mentions a month of the microsoft/FluidFramework repository that our weekly crawl found. There is no adoption data for this file yet.

Who's talking about microsoft/FluidFramework

The biggest 5 of 62 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 62

Talked about on GitHub, Stack Overflow and Hacker News (62 times).

On GitHub · 50

45 more on GitHub

The file

Show its rules and text

We split this skill into the rules it gives an agent

18 rules. About 0 are common, 12 are distinctive, and 6 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈12

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 6

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    When you apply an exception, you MUST explicitly report — every single time, with no abbreviation across repeated runs — that (a) you …

    line 17
  2. Distinctive:

    Check: Run CI script → Review output → Report final status

    line 23
  3. Distinctive:

    Test: same as Build, plus Run tests

    line 25
  4. Distinctive:

    Before doing anything, ask the user:

    line 34
  5. Distinctive:

    Wait for the user's response.

    line 43
  6. Distinctive:

    Run the bundled script from the repository root:

    line 47
  7. Very specific:

    Check changeset warnings against the release-group guidance.

    line 60
  8. Very specific:

    If API reports changed, use the api-changes skill for details.

    line 61
  9. Distinctive:

    Check mode stops here — skip steps 4–8 entirely.

    line 81
  10. Very specific:

    If @fluidframework/tree is among the changed packages and its API surface likely changed, read …

    line 105
  11. Very specific:

    If API Extractor fails with ae-missing-release-tag, add a TSDoc release tag (@alpha, @beta, @public, or @internal) to the new export, …

    line 113
  12. Distinctive:

    After regenerating reports, check whether any api-report files actually changed:

    line 117
  13. Very specific:

    If any api-report files changed, run the api-changes skill.

    line 123
  14. Very specific:

    If you see ae-unresolved-link errors, the {@link} or {@inheritdoc} tag references an ambiguous name.

    line 133
  15. Distinctive:

    Run whichever test scripts exist in each built changed package:

    line 145
  16. Distinctive:

    Run git status and report:

    line 156
  17. Distinctive:

    Test results — if Test mode, pass/fail per package

    line 160
  18. Distinctive:

    If further code changes are made after this check, re-run ESLint and — if the API surface changed — regenerate API reports before pushing.

    line 166

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md
<required> **You MUST ask the user the Step 1 mode-choice question before doing anything else.** Do not pick a mode for them. Do not default to a mode. Auto/autonomous mode does NOT authorize you to skip this question - being in auto mode is never a valid reason to bypass the prompt.

There are exactly two narrow exceptions where you MAY skip the Step 1 mode-choice question. Both must be applied conservatively; if you are not certain an exception applies, you MUST ask.

  1. No-op since the last check in this conversation. The most recent CI readiness check in the current conversation already ran, and every change since then is obviously/provably outside the scope of any check the skill performs. Examples that qualify: edits only to comments; edits only to repository agent configuration under .github/skills/; edits only to repo-root README.md / CHANGELOG.md; or edits only to top-level docs not in a docs/* package. Watch out: docs/api/ and similar are themselves workspace packages — markdown inside a workspace package does NOT automatically qualify. If you cannot quickly verify the changed files are outside every workspace package, ask.
  2. Explicit standing instruction. The user has explicitly told you — in this conversation or in a saved memory entry — to auto-skip the CI readiness check without asking. Inferred preference, prior approvals of past runs, or general "be less interruptive" guidance does NOT qualify.

If either exception applies, treat it as equivalent to the user picking Skip in Step 1: do NOT ask the mode-choice question, do NOT create CI-readiness tasks/todos, and do NOT run the CI script or any other build/test/API-report steps. Stop the skill after reporting the skip.

When you apply an exception, you MUST explicitly report — every single time, with no abbreviation across repeated runs — that (a) you skipped asking the mode-choice question, (b) the CI readiness check itself was skipped, and (c) which exception applied. Silent skipping is forbidden.

When neither exception applies, ask the user and wait for their response. Immediately after they respond, create one task/todo item per applicable step using the available Copilot task-management tooling — before doing any other work. Mark each task in progress when you start it and completed when you finish. This prevents steps from being silently skipped as context grows.

Tasks to create by mode:

  • Check: Run CI script → Review output → Report final status
  • Build: Run CI script → Review output → Build unbuilt packages → ESLint auto-fix → Regenerate API reports → API changes review → Run build:docs → Regenerate type tests → Report final status
  • Test: same as Build, plus Run tests

For Build/Test: if @fluidframework/tree is among the changed packages and its API surface likely changed, add a "Cascade API reports to aggregator packages" task after "Regenerate API reports".

Omit steps that don't apply (e.g. skip "Build unbuilt packages" if everything is already built; skip "Regenerate API reports" and "Regenerate type tests" if the API surface didn't change). </required>

Step 1: Confirm with the user

Before doing anything, ask the user:

I can run a CI readiness check on your branch. Pick a mode (fastest to slowest):

  1. Skip — skip the CI readiness check
  2. Check (quick) — auto-fix formatting, policy, and syncpack on changed packages
  3. Build — Check + build unbuilt packages + ESLint + regenerate API reports and type tests
  4. Test (slower) — Build + run the test suite in changed packages

Wait for the user's response. If they say skip (or anything clearly negative), stop here. Otherwise, note their choice and immediately create tasks for all remaining steps as described in the required block above before proceeding.

Step 2: Run the script

Run the bundled script from the repository root:

bash .github/skills/ci-readiness-check/ci-readiness-check.sh [base-branch]

The base branch defaults to main. Pass a different branch if needed (e.g., next).

The script detects changed packages, installs dependencies if needed, runs fluid-build --task checks:fix (auto-fixing formatting, policy, syncpack, and build version consistency), verifies all checks pass, checks for a changeset, and reports uncommitted changes and build status.

Step 3: Review output

Report to the user: packages changed, what was auto-fixed, any checks still failing, and uncommitted files. Check changeset warnings against the release-group guidance. If API reports changed, use the api-changes skill for details.

If you see unexpected generated artifacts unrelated to the branch's changes (especially in *.api.md files), stale build artifacts from a previous session or the incremental TypeScript bug are likely the cause. For @fluidframework/tree or its aggregator (fluid-framework), a scoped per-package clean is not reliable — you must do a full clean build from the repo root:

# From the repo root — no shortcuts
pnpm clean
pnpm build

The full build includes API report generation for all packages (including the fluid-framework aggregator), so no separate regeneration step is needed. Check the reports afterward — if only your intended changes appear, you're good.

For other packages, a scoped clean may suffice:

cd $PKG && pnpm exec fluid-build . --task clean && pnpm exec fluid-build . --task compile

Then re-run the CI readiness check. Never hand-edit *.api.md files — they are generated artifacts. If they're wrong, rebuild and regenerate.

Check mode stops here — skip steps 4–8 entirely. Note what was skipped in the final report.

Step 4: Handle unbuilt packages (Build and Test only)

cd $PKG && pnpm exec fluid-build . --task compile

Step 5: ESLint auto-fix (Build and Test only)

cd $PKG && pnpm exec fluid-build . -t eslint:fix

eslint:fix ensures compilation is current before linting and uses incremental caching so it's fast when the package is already built. If it fails due to non-auto-fixable errors, note them but continue.

Determining if the public API surface changed

Steps 6 and 7 only run if the public API surface changed. Proceed if: src/index.ts or any entry point (src/alpha.ts, src/beta.ts, src/legacy.ts, src/internal.ts) was modified; any exported type/interface/class/function signature changed; or package.json exports changed. Skip if only tests, internal implementation, comments, or function bodies (not signatures) changed.

Running build:api-reports when nothing changed can introduce spurious diffs — specifically for the @fluidframework/tree and fluid-framework packages, which surface a known incremental TypeScript bug that non-deterministically reorders type unions and can cause other phantom changes. If you see any unexpected API report diffs, do a full clean build from the repo root (pnpm clean && pnpm build) and regenerate. Per-package cleans are not reliable for the tree package. See tree-api-checks.md for details.

Step 6: API reports and cross-package cascade (Build and Test only)

If @fluidframework/tree is among the changed packages and its API surface likely changed, read .github/skills/ci-readiness-check/tree-api-checks.md before proceeding with 6a.

6a. Regenerate API reports

cd $PKG && pnpm exec fluid-build . -t build:api-reports

If API Extractor fails with ae-missing-release-tag, add a TSDoc release tag (@alpha, @beta, @public, or @internal) to the new export, rebuild, then retry.

6b. API changes review

After regenerating reports, check whether any api-report files actually changed:

git diff --name-only HEAD -- | grep api-report

If any api-report files changed, run the api-changes skill. It will classify the changes by release tag, determine whether API Council approval is needed, flag any breaking changes that require process steps, and verify changeset and deprecation requirements.

6c. Run build:docs to catch TSDoc errors

build:api-reports suppresses ae-unresolved-link errors; CI catches these via build:docs. Run for each built changed package with a build:docs script, regardless of API surface change:

cd $PKG && pnpm run build:docs

If you see ae-unresolved-link errors, the {@link} or {@inheritdoc} tag references an ambiguous name. Fix by linking to an unambiguous target. The TSDoc :instance/:static selectors are not supported by this version of API Extractor.

Step 7: Type test regeneration (Build and Test only)

For each built changed package with a typetests:gen script and where the public API surface likely changed:

cd $PKG && pnpm run typetests:gen

Step 8: Run tests (Test mode only)

Run whichever test scripts exist in each built changed package:

cd $PKG && pnpm run test:mocha
cd $PKG && pnpm run test:jest

Skip test:benchmark, test:stress, and test:realsvc — too slow and flaky for a pre-push check. Report all results for the final report even if some fail.

Step 9: Final status

Run git status and report:

  1. Files auto-fixed — formatting, policy, ESLint fixes (unstaged; user should review and stage)
  2. Generated files updated — API reports, type tests (need to be committed with the PR)
  3. Test results — if Test mode, pass/fail per package
  4. Remaining issues — anything the skill couldn't auto-fix
  5. Skipped checks — anything skipped due to mode choice or unbuilt packages

End with a clear statement: "Your branch is ready to push" or "These issues remain: ..."

If further code changes are made after this check, re-run ESLint and — if the API surface changed — regenerate API reports before pushing.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.