skills.rest
microsoft
microsoftOFFICIAL
Explore all skills by this author →
Website𝕏@OpenAtMicrosoftGitHub

ci-readiness-check

Validates Fluid Framework branches against CI checks before pushing to remote.

4.9k|585|Updated Aug 22, 2019
Search Tags:#lint#pre-push#Monorepo#ci#changeset#api reports#fluid framework
One-click install
npx skills add https://github.com/microsoft/FluidFramework --skill ci-readiness-check
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: ci-readiness-check
Source: https://github.com/microsoft/FluidFramework/tree/main/.claude/skills/ci-readiness-check
Command: npx skills add https://github.com/microsoft/FluidFramework --skill ci-readiness-check

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Pushing a branch only to watch CI fail on formatting, stale API reports, missing changesets, or policy violations wastes review cycles. This Skill catches those common CI failures locally before you push, auto-fixing what it can and clearly reporting what remains.

Core Features & Use Cases

  • Tiered check modes: Choose Skip, Check (quick auto-fix of formatting, policy, and syncpack), Build (adds compilation, ESLint, API report and type test regeneration), or Test (adds the package test suites).
  • Automated pre-push script: Detects changed packages versus a base branch, runs fluid-build --task checks:fix, verifies checks pass, and flags missing changesets and uncommitted generated files.
  • API report guidance: Handles the known incremental TypeScript bug affecting @fluidframework/tree and the fluid-framework aggregator, directing a full clean build when unexpected API report diffs appear.
  • Use Case: You finished a change to a Fluid Framework package and ask for a CI readiness check; the Skill auto-fixes formatting and policy issues, regenerates API reports, runs tests, and tells you whether the branch is ready to push.

Quick Start

Ask the assistant to run a CI readiness check on your current branch before pushing, then pick a mode when prompted.

Frequently Asked Questions about ci-readiness-check

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check if my Fluid Framework branch is ready to push?▼

Ask for a CI readiness check and pick a mode: Check, Build, or Test. The skill runs a script that detects changed packages, auto-fixes formatting and policy issues, verifies checks pass, and reports uncommitted generated files.

How do I fix formatting and policy violations before CI runs?▼

Run the ci-readiness-check script, which executes `fluid-build --task checks:fix` scoped to changed packages. This auto-fixes biome formatting, policy violations, syncpack mismatches, and build version consistency in dependency order.

Why do Fluid Framework API reports show unexpected diffs?▼

A known incremental TypeScript bug in @fluidframework/tree and the fluid-framework aggregator non-deterministically reorders union types and adds phantom entries. The fix is a full clean build from the repo root with pnpm clean and pnpm build, never hand-editing api.md files.

Does the CI readiness check run tests automatically?▼

Tests only run in Test mode, the slowest tier. It runs test:mocha and test:jest in each built changed package, while skipping benchmark, stress, and realsvc suites that are too slow or flaky for a pre-push check.

When is a changeset required in the Fluid Framework repo?▼

A changeset is required when a PR modifies published package source code. The script runs `pnpm flub check changeset` against the base branch and warns if one is missing, directing you to run `pnpm changeset`.

Related Skills

Explore More Software Engineering Skills→
ArthTech-AIArthTech-AI

precheck

Run local pre-push tests on changed hooks, skills, and manifests.

Official
Advanced
robin-lirobin-li
6

vibe-sdlc-pr

Monitor PR CI status, triage failures, and apply safe fixes.

Community
Advanced
reactivereactive
2.0k

changeset

Generate changesets and release notes from code changes in multi-package projects.

Official
Advanced
pantheon-orgpantheon-org
1

pr-iteration

Iteratively fix lint, typecheck, test, and build failures until CI passes.

Official
Intermediate