final-release-review

Audit git diffs from the previous release tag for breaking changes and risks.

6|2|Updated Aug 22, 2024
One-click install
npx skills add https://github.com/NQ-lovecpp/cpp_chatsystem --skill final-release-review-nq-lovecpp
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: final-release-review
Source: https://github.com/NQ-lovecpp/cpp_chatsystem/tree/main/ChatSystem-Backend/8.Agent_Server/examples/openai-agents-python-main/.agents/skills/final-release-review
Command: npx skills add https://github.com/NQ-lovecpp/cpp_chatsystem --skill final-release-review-nq-lovecpp

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill automates the critical process of reviewing code changes before a release, ensuring stability and preventing regressions by systematically auditing differences between release candidates.

Core Features & Use Cases

  • Automated Tag Discovery: Identifies the previous release tag automatically.
  • Diff Auditing: Analyzes code changes for breaking modifications, regressions, and potential risks.
  • Risk Assessment: Provides a structured evaluation of identified issues with clear impact statements.
  • Release Gate: Offers a decisive ship/block recommendation based on predefined policies.
  • Use Case: Before deploying a new version of openai-agents-python, use this Skill to confirm that no critical bugs were introduced and that all changes align with the release strategy.

Quick Start

Run the final release review skill to audit changes from the previous release tag to the latest commit on main.

Frequently Asked Questions about final-release-review

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

FAQPage Schema
How do I audit git diffs for breaking changes before a release?

To audit git diffs for breaking changes before a release, locate the previous release tag and analyze the commit history to identify regressions, risks, and improvement opportunities. This ensures software stability and validates release readiness through a structured risk assessment.

What is an automated release readiness review?

An automated release readiness review systematically audits code differences between release candidates using shell scripts and git commands. It discovers previous release tags, evaluates diffs for breaking modifications, and applies a deterministic gate policy to provide ship or block recommendations.

How do I automatically discover the previous release tag in git?

To automatically discover the previous release tag in git, utilize shell scripts designed for tag discovery that query remote tags. This process accurately locates the baseline tag needed to generate a comprehensive diff for your release risk assessment.

Can I get a ship or block recommendation based on a git diff risk assessment?

Yes, you can get a decisive ship or block recommendation by evaluating the git diff against a deterministic gate policy. This policy analyzes the structured risk assessment of identified breaking changes and regressions to offer actionable release recommendations.

Does this release review process require any specific dependencies?

The release review process requires no external dependencies, relying entirely on standard shell scripts and git commands. It operates independently to locate remote tags and audit diffs, making it suitable for any standard development environment.