skills.rest
dotnet
dotnetOFFICIAL
Explore all skills by this author →
Website𝕏@dotnetfdnGitHub

run-apichief

Generate and review API baselines, summaries, and deltas for .NET libraries.

3.2k|886|Updated Feb 17, 2015
Search Tags:#api#review#dotnet#baseline#api chief
One-click install
npx skills add https://github.com/dotnet/extensions --skill run-apichief
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: run-apichief
Source: https://github.com/dotnet/extensions/tree/main/.github/skills/run-apichief
Command: npx skills add https://github.com/dotnet/extensions --skill run-apichief

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill automates the process of generating and reviewing API baselines, summaries, and deltas for breaking changes in .NET libraries.

Core Features & Use Cases

  • API Baseline Generation: Create baseline files for API contracts.
  • API Review: Provide human-readable summaries and review files for API changes.
  • Delta Comparison: Generate deltas against previous baselines to track changes.
  • Breaking Change Detection: Check for breaking changes against a baseline.
  • Use Case: Utilize this Skill in a CI/CD pipeline to ensure API stability and backwards compatibility during library updates.

Quick Start

Use the run-apichief skill to generate a baseline for the Microsoft.Extensions.AI library by running 'run-apichief Microsoft.Extensions.AI'.

Frequently Asked Questions about run-apichief

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

FAQPage Schema
How do I generate an API baseline for a .NET library?▼

Generate API baselines for .NET libraries by running the run-apichief command with a specific library name matching a folder in src/Libraries. The tool uses ApiChief to emit baseline files capturing the current API contract.

What is an API baseline and when do I need it for .NET development?▼

An API baseline is a snapshot of a library's public API contract used to track changes and detect breaking modifications. You need API baselines when updating .NET libraries to ensure backwards compatibility and API stability.

Can I check for breaking changes in .NET libraries automatically?▼

Check for breaking changes in .NET libraries automatically by using the ApiChief check breaking command against a previously generated baseline. This validates that new updates do not violate existing API contracts.

How do I track API deltas between .NET library versions?▼

Track API deltas between .NET library versions by running the emit delta command against a previous baseline. This generates a comparison file showing exactly what API changes occurred between versions.

Does this API review tool work in a CI/CD pipeline?▼

Yes, this API review tool works in CI/CD pipelines to ensure API stability and backwards compatibility during .NET library updates. It emits human-readable summaries and review files for automated change validation.

What's the best way to review API changes for .NET libraries?▼

Review API changes for .NET libraries by emitting human-readable summary and review files using ApiChief. This approach provides clear visibility into API modifications and helps maintain contract stability across updates.

Related Skills

Explore More Software Engineering Skills→
mdementyevmdementyev

ilspy-decompile

Decompile .NET assemblies to readable C# code with ILSpy.

Community
Intermediate
ReefBytesReefBytes
1

database-migration-guard

Validate database migrations for breaking changes and backwards compatibility in CI pipelines.

Community
Advanced
UvRoxxUvRoxx
8

midnight-test-runner

Run and debug Midnight contract tests using Vitest simulators.

Community
Intermediate
rudironsonirudironsoni

dotnet-api-surface-validation

Validate .NET public API surface changes with PublicApiAnalyzers and Verify snapshots.

Community
Intermediate