Skip to content

feat(sdlc-workflow): add release-notes skill#195

Draft
ptomanRH wants to merge 1 commit into
RHEcosystemAppEng:mainfrom
ptomanRH:feat/release-notes-skill
Draft

feat(sdlc-workflow): add release-notes skill#195
ptomanRH wants to merge 1 commit into
RHEcosystemAppEng:mainfrom
ptomanRH:feat/release-notes-skill

Conversation

@ptomanRH

@ptomanRH ptomanRH commented Jun 19, 2026

Copy link
Copy Markdown

Summary

  • Adds a new release-notes skill to the sdlc-workflow plugin that guides engineers and technical writers through the RHTPA release notes process
  • Supports three modes: Document (engineer fills template & links to tracker), Review (tech writer rewrites in AsciiDoc & proposes), Approve (engineer approves/rejects)
  • Automates Jira custom field updates (Release Note Type, Text, Status) and Document link creation to Release Notes tracker epics

Details

The skill implements the Release Notes Process for Trusted Profile Analyzer as an interactive SDLC workflow, covering all 7 steps across both Engineer and Technical Writer roles.

Three operating modes

Mode Invocation Role Steps covered
Document /release-notes TC-XXXX Engineer Steps 1-3: Assess relevance, select type, fill template, link to tracker
Review /release-notes review TC-XXXX Tech Writer Steps 4-5: Review text, rewrite in AsciiDoc, set status to Proposed
Approve /release-notes approve TC-XXXX Engineer Steps 6-7: Approve (Done) or reject (Rejected) with feedback

Release Note Templates

  • Known Issue: Cause / Consequence / Workaround / Result of Workaround
  • Bug Fix: Cause / Consequence / Fix / Result of Fix
  • Feature: Feature / Reason / Result

Jira Custom Fields Used

  • customfield_10785 — Release Note Type
  • customfield_10783 — Release Note Text
  • customfield_10807 — Release Note Status
  • Document link type (ID: 10079) for tracker linking

Test plan

  • Run /release-notes TC-XXXX on an issue without release note fields set — verify all 3 templates work
  • Run /release-notes TC-XXXX on an issue that already has release note fields — verify update flow
  • Run /release-notes review TC-XXXX on an issue with status "In Progress" — verify AsciiDoc rewrite
  • Run /release-notes approve TC-XXXX on an issue with status "Proposed" — verify approve/reject flows
  • Verify Document link is created correctly to the Release Notes tracker
  • Verify duplicate link detection works

🤖 Generated with Claude Code

Summary by Sourcery

Add a new sdlc-workflow release-notes skill that guides engineers and technical writers through the end-to-end Jira-based release notes process for Trusted Profile Analyzer.

New Features:

  • Introduce a release-notes skill with document, review, and approve modes for managing release notes within Jira.
  • Define structured templates for Known Issue, Bug Fix, and Feature release notes tied to Jira custom fields and document links.
  • Support interactive workflows for assessing release note relevance, drafting content, linking issues to release-note trackers, and coordinating approvals between engineers and technical writers.

Enhancements:

  • Document strict guardrails and Jira access patterns, including MCP-first behavior, REST API fallback, and mandatory comment footnotes for the release-notes workflow.

Add a new skill that guides engineers and technical writers through
the Trusted Profile Analyzer release notes process. The skill operates
in three modes:

- Document mode: Engineer assesses an issue, fills the release note
  template (Known Issue / Bug Fix / Feature), and links to a tracker
- Review mode: Technical Writer rewrites the text in AsciiDoc format
  and proposes it for engineer review
- Approve mode: Engineer approves or rejects the proposed text

The skill automates Jira field updates (Release Note Type, Text, and
Status custom fields) and creates Document links to Release Notes
tracker epics.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@sourcery-ai

sourcery-ai Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Adds a new Jira-focused release-notes skill to the sdlc-workflow plugin that implements the Trusted Profile Analyzer release notes process end-to-end across three modes (Document, Review, Approve), including guardrails, Jira configuration discovery, MCP-vs-REST access pattern, structured templates, and status/link automation.

File-Level Changes

Change Details Files
Introduce a new release-notes SDLC workflow skill that guides engineers and technical writers through Trusted Profile Analyzer release notes using three interactive modes (Document, Review, Approve).
  • Define skill metadata (name, description, argument format) and high-level behavior for engineer vs. technical-writer roles.
  • Implement mode selection based on the command arguments to distinguish document, review, and approve flows.
  • Describe guardrails restricting the skill to Jira-only operations and prohibiting filesystem modification except for a tightly scoped Jira REST fallback.
plugins/sdlc-workflow/skills/release-notes/SKILL.md
Codify the full release notes lifecycle for TPA, including templates, Jira custom fields, and tracker linking, as a step-by-step workflow.
  • Provide three structured templates (Known Issue, Bug Fix, Feature) and scripted question flows to collect the required fields from users.
  • Map Jira custom fields for Release Note Type, Text, and Status and define the Document issue-link type semantics for connecting engineering issues to release-notes tracker epics.
  • Specify stepwise behavior for Document mode: issue inspection, relevance assessment, type selection, template filling, Jira field updates, and linking the issue to a chosen release tracker while avoiding duplicate links.
plugins/sdlc-workflow/skills/release-notes/SKILL.md
Define reviewer and approver workflows that rewrite and finalize release notes, integrate with Jira comments, and enforce status transitions.
  • Describe Review mode behavior for technical writers: validate preconditions, rewrite text into AsciiDoc narrative form, update Jira fields to Proposed, and notify the assignee via a comment using the shared comment-footnote format.
  • Describe Approve mode behavior for engineers: validate Proposed status, present the proposed text, and drive either approval (status Done + thank-you comment) or rejection (status Rejected + feedback comment and re-review instructions).
  • Enforce rules such as using only user/provided issue content (no fabrication), always preview changes before Jira updates, and stopping on CVE-related issues or misconfigured CLAUDE.md release-notes settings.
plugins/sdlc-workflow/skills/release-notes/SKILL.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant