branch-readiness-checks

Run diff analysis, linting, type checking, and unit tests on affected packages.

21.2k|8.6k|Updated Jan 26, 2013
One-click install
npx skills add https://github.com/elastic/kibana --skill branch-readiness-checks
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: branch-readiness-checks
Source: https://github.com/elastic/kibana/tree/main/.agents/skills/branch-readiness-checks
Command: npx skills add https://github.com/elastic/kibana --skill branch-readiness-checks

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill automates the process of validating code changes against project standards and potential CI failures before a developer commits or pushes their code.

Core Features & Use Cases

  • Pre-commit Validation: Runs essential checks like linting, type checking, and unit tests on affected code.
  • Dependency Awareness: Identifies and checks downstream dependencies impacted by code changes.
  • Use Case: A developer makes changes to a feature. Before pushing, they run this Skill to ensure their code adheres to TypeScript standards, passes all relevant unit tests, and doesn't break other parts of the application, preventing common CI errors.

Quick Start

Run branch readiness checks to validate your code before pushing.

Frequently Asked Questions about branch-readiness-checks

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

FAQPage Schema
How do I run pre-commit checks for TypeScript linting and unit testing?

Run pre-commit checks by executing a sequential workflow that performs diff analysis, linting, type checking, and unit tests on affected packages. This validates code quality and identifies potential CI failures before you push your code.

What is the best way to prevent CI failures from breaking downstream package dependencies?

Preventing CI failures from breaking downstream dependencies is achieved through dependency awareness, which identifies impacted packages and validates them. This sequential check process flags potential errors and coverage gaps before code is committed.

Can I automatically fix linting and type errors before pushing my code?

Yes, you can automatically fix linting and type errors during branch readiness validation. The workflow identifies these issues and offers automated fixes while simultaneously flagging any existing test coverage gaps.

Does this branch readiness validation work with Git and CI workflows?

Branch readiness validation works directly with Git and CI workflows by analyzing code diffs to run targeted checks. It ensures your changes adhere to project standards and prevents common CI errors before a developer commits or pushes.

How does diff analysis identify which packages need unit tests and type checking?

Diff analysis identifies affected packages by evaluating your code changes against the project structure. It then sequentially targets only those impacted downstream dependencies for linting, type checking, and unit testing to ensure comprehensive validation.