skills.rest
openshift-eng
openshift-engCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

Create Release Note

Generate Jira release notes from bug descriptions and linked GitHub PRs.

112|305|Updated Oct 10, 2025
Search Tags:#automation#documentation#github#jira#release-notes#bug-fix
One-click install
npx skills add https://github.com/openshift-eng/ai-helpers --skill create-release-note
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: Create Release Note
Source: https://github.com/openshift-eng/ai-helpers/tree/main/plugins/jira/skills/create-release-note
Command: npx skills add https://github.com/openshift-eng/ai-helpers --skill create-release-note

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires gh.

What problem does it solve?

This Skill eliminates the manual effort of writing release notes by automatically analyzing Jira bug tickets and their linked GitHub pull requests to generate comprehensive bug fix documentation.

Core Features & Use Cases

  • Automated Analysis: Extracts cause and consequence from Jira bug descriptions and synthesizes fix details from GitHub PRs.
  • Multi-Source Integration: Combines information from Jira tickets, PR descriptions, code diffs, and comments.
  • Use Case: When a critical bug OCPBUGS-38358 is fixed, this Skill automatically generates the complete release note including cause, consequence, fix, and result sections.

Quick Start

Use the Create Release Note skill to generate a release note for Jira bug OCPBUGS-38358 by analyzing its linked GitHub pull requests and bug description.

Frequently Asked Questions about Create Release Note

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

FAQPage Schema
How do I automatically generate release notes from Jira bugs and GitHub PRs?▼

Automatically generate release notes by analyzing Jira bug descriptions and linked GitHub pull requests. This Skill extracts cause and consequence from the bug ticket, synthesizes fix details from PRs, and outputs formatted Release Note Type and Text fields directly into Jira.

Can I use this to create release notes across multiple Jira projects and release cycles?▼

Yes, this Skill applies to Jira Bug issues with linked GitHub pull requests across projects and release cycles. It validates issue type as Bug, parses the description, and generates or regenerates Release Note fields for each bug systematically.

What information does the Skill extract from GitHub PRs for the release note?▼

The Skill extracts PR descriptions, code diffs, and comments alongside Jira bug details. It combines this multi-source information to synthesize fix details, consequences, and results sections in the final Release Note Text output.

Do I need both Jira and GitHub connected to use this automation?▼

Yes, the Skill requires Jira Bug issues with linked GitHub pull requests. It fetches Jira data via MCP and uses the gh CLI to access linked PRs, so both platforms must be accessible and the bug must have associated pull requests.

What happens if a Jira bug doesn't have a linked GitHub PR?▼

The Skill validates that the issue is a Bug type and checks for linked GitHub pull requests. Bugs without linked PRs cannot be processed, as the Skill depends on PR data to generate the complete release note with fix and result details.

Can I regenerate release notes for existing bugs?▼

Yes, this Skill creates or regenerates Release Note fields in Jira. You can run it against previously documented bugs to update their release notes with refreshed analysis from Jira descriptions and linked GitHub PRs.

Related Skills

Explore More Software Engineering Skills→
openshift-engopenshift-eng
112

Jira Pull Request Extractor

Discover Jira issues recursively and extract GitHub Pull Request links into deduplicated JSON.

Community
Advanced
cedicedi
7

changelog-generator

Generate customer-facing release notes from Git commit history.

Community
Intermediate
luigiinredluigiinred
1

dev-workflow-review-pr

Review GitHub pull requests by analyzing diffs and posting inline comments.

Community
Advanced
decentpastedecentpaste
232

github-release

Generate GitHub releases from conventional commit messages.

Official
Advanced