release-preflight

Validate release packaging, installation, security, and API consistency before publication.

5|1|Updated Dec 10, 2025
One-click install
npx skills add https://github.com/Pravin-surawase/structural_engineering_lib --skill release-preflight-pravin-surawase
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: release-preflight
Source: https://github.com/Pravin-surawase/structural_engineering_lib/tree/main/.github/skills/release-preflight
Command: npx skills add https://github.com/Pravin-surawase/structural_engineering_lib --skill release-preflight-pravin-surawase

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill prevents broken releases by catching packaging mistakes, missing runtime files, import warnings, security gaps, and API or documentation drift before a version goes public.

Core Features & Use Cases

  • Packaging verification: Confirms wheels and source distributions include the right files and exclude tests or leaked artifacts.
  • User acceptance checks: Installs the built package in a clean environment and exercises core workflows from a real user perspective.
  • Security and consistency review: Scans for risky error handling, obvious dependency issues, and mismatches between the documented API and the actual package surface.
  • Use case: Run this before a release PR or PyPI publish to confirm the build is safe, functional, and aligned with the README.

Quick Start

Ask the assistant to run the full pre-release validation for the current version and summarize any blockers, failures, or release readiness concerns.

Frequently Asked Questions about release-preflight

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

FAQPage Schema
How do I validate a Python wheel before publishing to PyPI?

To validate a Python wheel before publishing, run pre-release validation that inspects wheel packaging, checks for leaked artifacts, and verifies core workflows run cleanly. This process confirms the build is safe, functional, and ready for publication.

What is release preflight and when do I need it for my software project?

Release preflight is a validation process for software projects that catches packaging mistakes, missing runtime files, and security gaps before a version goes public. You need it before merging a release PR or publishing to PyPI to confirm the build is safe.

How do I check for API consistency and documentation drift in a release?

You can check for API consistency and documentation drift by running consistency checks that compare the documented API against the actual package surface. This detects mismatches between the README and the installed package before publication.

Can I test package installation behavior in a clean environment before release?

Yes, you can test package installation behavior by installing the built package in a clean environment and exercising core workflows from a real user perspective. This user acceptance check confirms the runtime import validation and core workflow execution succeed.

How do I scan my release build for security vulnerabilities and risky error handling?

You can scan your release build for security vulnerabilities by running a security and consistency review that scans for risky error handling and obvious dependency issues. This vulnerability scanning identifies security gaps before the version goes public.

What is the best way to prevent broken releases caused by packaging mistakes?

The best way to prevent broken releases is to run full pre-release validation that confirms wheels and source distributions include the right files and exclude tests or leaked artifacts. This build verification ensures the release is ready for publication.