Skip to content

chore: add release-notes skill#2568

Merged
chmouel merged 1 commit intotektoncd:mainfrom
chmouel:add-release-notes-skill
Mar 16, 2026
Merged

chore: add release-notes skill#2568
chmouel merged 1 commit intotektoncd:mainfrom
chmouel:add-release-notes-skill

Conversation

@chmouel
Copy link
Copy Markdown
Member

@chmouel chmouel commented Mar 12, 2026

Replace the Python-based release note generation script that was run on
release with a Claude-native skill.

This transition enables automated release note categorization and GitHub
release management directly through Claude without relying on external
AI API dependencies.

The issue is that the gemini api was timing out and was not that smart
at categorization, when the skills offer more versatility.

Signed-off-by: Chmouel Boudjnah chmouel@redhat.com

📝 Description of the Change

👨🏻‍ Linked Jira

🔗 Linked GitHub Issue

Fixes #

🧪 Testing Strategy

  • Unit tests
  • Integration tests
  • End-to-end tests
  • Manual testing
  • Not Applicable

🤖 AI Assistance

  • I have not used any AI assistance for this PR.
  • I have used AI assistance for this PR.

If you have used AI assistance, please provide the following details:

Which LLM was used?

  • GitHub Copilot
  • ChatGPT (OpenAI)
  • Claude (Anthropic)
  • Cursor
  • Gemini (Google)
  • Other: ____________

Extent of AI Assistance:

  • Documentation and research only
  • Unit tests or E2E tests only
  • Code generation (parts of the code)
  • Full code generation (most of the PR)
  • PR description and comments
  • Commit message(s)

Important

If the majority of the code in this PR was generated by an AI, please add a Co-authored-by trailer to your commit message.
For example:

Co-authored-by: Gemini gemini@google.com
Co-authored-by: ChatGPT noreply@chatgpt.com
Co-authored-by: Claude noreply@anthropic.com
Co-authored-by: Cursor noreply@cursor.com
Co-authored-by: Copilot Copilot@users.noreply.github.com

**💡You can use the script ./hack/add-llm-coauthor.sh to automatically add
these co-author trailers to your commits.

✅ Submitter Checklist

  • 📝 My commit messages are clear, informative, and follow the project's How to write a git commit message guide. The Gitlint linter ensures in CI it's properly validated
  • ✨ I have ensured my commit message prefix (e.g., fix:, feat:) matches the "Type of Change" I selected above.
  • ♽ I have run make test and make lint locally to check for and fix any
    issues. For an efficient workflow, I have considered installing
    pre-commit and running pre-commit install to
    automate these checks.
  • 📖 I have added or updated documentation for any user-facing changes.
  • 🧪 I have added sufficient unit tests for my code changes.
  • 🎁 I have added end-to-end tests where feasible. See README for more details.
  • 🔎 I have addressed any CI test flakiness or provided a clear reason to bypass it.
  • If adding a provider feature, I have filled in the following and updated the provider documentation:
    • GitHub App
    • GitHub Webhook
    • Gitea/Forgejo
    • GitLab
    • Bitbucket Cloud
    • Bitbucket Data Center

@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request transitions the project's release note generation from a Python script that used the Gemini API to a new, integrated Claude-native skill. This change aims to enhance the reliability and intelligence of release note categorization, streamline the release process, and reduce external dependencies by handling GitHub release updates directly within the Claude environment.

Highlights

  • New Release Notes Skill: Introduced a new Claude-native skill for generating release notes, replacing the previous Python-based script and Gemini API integration.
  • Automated Categorization and GitHub Integration: The new skill enables automated categorization of changes and direct management of GitHub releases, reducing reliance on external AI API dependencies.
  • Improved Reliability: Addressed previous issues with the Gemini API timing out and providing less intelligent categorization by leveraging Claude's capabilities.
Changelog
  • .claude/skills/release-notes/SKILL.md
    • Added a new Claude skill definition for release note generation, including detailed workflow steps for tag detection, data gathering, categorization, and GitHub release updates.
  • .claude/skills/release-notes/references/release-notes-format.md
    • Added a new reference document outlining the required markdown format for release note entries, headers, and installation sections.
  • .tekton/release-pipeline.yaml
    • Removed the 'ai-release-notes' task, which previously executed the Python script for release note generation, from the Tekton release pipeline.
  • docs/content/docs/dev/release-process.md
    • Updated the development release process documentation to reflect the new method of generating release notes using the Claude skill.
  • hack/generate-releasenotes.py
    • Removed the Python script that was previously responsible for generating AI-powered release notes using the Gemini API.
Activity
  • The author, chmouel, created this pull request to replace the Python-based release note generation script with a Claude-native skill.
  • The motivation for this change was the Gemini API timing out and not being as effective at categorization as desired.
  • No explicit reviewer comments or activities have been recorded yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@pipelines-as-code
Copy link
Copy Markdown

pipelines-as-code bot commented Mar 12, 2026

🔍 PR Lint Feedback

Note: This automated check helps ensure your PR follows our contribution guidelines.

⚠️ Items that need attention:

🎫 Jira reference

Add a Jira reference in the description using one of the following formats:

  • https://issues.redhat.com/browse/SRVKP-<number>

If no SRVKP ticket exists yet, link a GitHub issue instead (e.g., Fixes #123).
Minor housekeeping PRs without Jira coverage can skip this after confirming with reviewers.


🤖 AI attribution

The following commits lack an explicit AI attribution footer:

  • 131d636 chore: add release-notes skill

If no AI assistance was used for a commit, you can ignore this warning.
Otherwise add an Assisted-by: or Co-authored-by: footer referencing the AI used.


ℹ️ Next Steps

  • Review and address the items above
  • Push new commits to update this PR
  • This comment will be automatically updated when issues are resolved
🔧 Admin Tools (click to expand)

Automated Issue/Ticket Creation:

  • /issue-create - Generate a GitHub issue from this PR content using AI
  • /jira-create - Create a SRVKP Jira ticket from this PR content using AI

⚠️ Important: Always review and edit generated content before finalizing tickets/issues.
The AI-generated content should be used as a starting point and may need adjustments.

These commands are available to maintainers and will post the generated content as PR comments for review.

🤖 This feedback was generated automatically by the PR CI system

@pipelines-as-code pipelines-as-code bot added documentation Improvements or additions to documentation llm labels Mar 12, 2026
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request replaces the Python-based release note generation script with a new Claude skill. The changes include adding the skill definition and reference documents, updating the release process documentation, and removing the old script and its corresponding CI task. The new skill definition is very detailed, but it misses handling for paginated API responses from GitHub, which could lead to incomplete release notes for large releases. Additionally, there are minor formatting issues in the reference documentation and grammatical errors in the updated process documentation.

Comment on lines +121 to +123
```bash
gh api repos/{owner}/{repo}/compare/{previous_tag}...{current_tag} --jq '.commits[].sha'
```
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The GitHub compare API endpoint is paginated and returns a maximum of 250 commits per request. If a release contains more than 250 commits, the total_commits field in the response will be greater than the number of commits in the commits array. The skill should handle this by paginating through the commits to gather all of them, otherwise release notes for larger releases will be incomplete. The previous Python script (hack/generate-releasenotes.py) had logic for this that could be used as a reference.

Comment on lines +42 to +46
Using claude (or others) skills you can do `/release-notes` to draft the
release notes it will guide thru the release notes generation and update the
release notes in the GitHub release page and a Slack announcement. The release
notes are generated based on the merged PRs since the last release, so it may
not be perfect, so you should always:
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This paragraph has some grammatical errors and could be clearer. Consider rephrasing for better readability.

Suggested change
Using claude (or others) skills you can do `/release-notes` to draft the
release notes it will guide thru the release notes generation and update the
release notes in the GitHub release page and a Slack announcement. The release
notes are generated based on the merged PRs since the last release, so it may
not be perfect, so you should always:
Using Claude skills, you can run the `/release-notes` command to draft the release notes. This will guide you through the generation process, update the release on the GitHub release page, and create a Slack announcement. The release notes are generated based on merged PRs since the last release and may not be perfect, so you should always:

Comment on lines +49 to +51
\`\`\`shell
kubectl apply -f https://github.com/{owner}/{repo}/releases/download/{tag}/release.yaml
\`\`\`
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The backticks for the shell code blocks are escaped with a backslash (\). This will cause them to render incorrectly in Markdown. Please remove the backslashes. This applies to all shell code blocks in this file.

Suggested change
\`\`\`shell
kubectl apply -f https://github.com/{owner}/{repo}/releases/download/{tag}/release.yaml
\`\`\`
kubectl apply -f https://github.com/{owner}/{repo}/releases/download/{tag}/release.yaml

@chmouel chmouel force-pushed the add-release-notes-skill branch 3 times, most recently from d582e4b to 388694a Compare March 12, 2026 11:49
@chmouel
Copy link
Copy Markdown
Member Author

chmouel commented Mar 12, 2026

/retest

@pipelines-as-code
Copy link
Copy Markdown

All PipelineRuns for this commit have already succeeded. Use /retest <pipeline-name> to re-run a specific pipeline or /test to re-run all pipelines.

@vdemeester
Copy link
Copy Markdown
Member

/retest

@pipelines-as-code
Copy link
Copy Markdown

All PipelineRuns for this commit have already succeeded. Use /retest <pipeline-name> to re-run a specific pipeline or /test to re-run all pipelines.

@theakshaypant
Copy link
Copy Markdown
Member

/retest

@chmouel
Copy link
Copy Markdown
Member Author

chmouel commented Mar 12, 2026

/ok-to-test

@pipelines-as-code
Copy link
Copy Markdown

All PipelineRuns for this commit have already succeeded. Use /retest <pipeline-name> to re-run a specific pipeline or /test to re-run all pipelines.

Replace the Python-based release note generation script that was run on
release with a Claude-native skill.

This transition enables automated release note categorization and GitHub
release management directly through Claude without relying on external
AI API dependencies.

The issue is that the gemini api was timing out and was not that smart
at categorization, when the skills offer more versatility.

Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
@chmouel chmouel force-pushed the add-release-notes-skill branch from 388694a to 131d636 Compare March 12, 2026 12:41
```markdown
* **Bold title:** One-sentence description of the change.
* Link: <PR_OR_COMMIT_URL>
* Jira: [SRVKP-XXXX](https://issues.redhat.com/browse/SRVKP-XXXX)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we still want to link Jira to the release notes?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good quesiton, i think we will keep it, since well it's public most of them and give other contexts

@tektoncd tektoncd deleted a comment from samchmou Mar 12, 2026
@chmouel chmouel merged commit 900e837 into tektoncd:main Mar 16, 2026
4 checks passed
@chmouel chmouel deleted the add-release-notes-skill branch March 16, 2026 23:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation llm

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants