PR Description Generator

VerifiedSafe

Analyzes branch changes with git diff/log and generates a complete GitHub-ready PR description, including breaking-change detection.

Sby Skills Guide Bot
DevOpsIntermediate
3010/18/2026
Claude CodeCursorCodex
#pull-request#git-diff#helm#breaking-changes#release-notes

Recommended for

Our review

Analyzes the current branch's changes against upstream/development and produces a fully filled pull request description ready to paste into GitHub.

Strengths

  • Flags Helm-specific breaking changes: renamed or removed value keys, Secret/ConfigMap names, NodePort numbers, and sub-chart major version bumps
  • Checks chart hygiene such as the Chart.yaml version bump, requirements.yaml/lock changes, and whether the README needs updating for new NodePorts or components
  • Applies explicit rules to tick or leave each checklist item, avoiding generic filler text
  • Emits a structured Markdown output with a [Scope] title and a concrete list of changed files and value keys

Limitations

  • Assumes a base branch named upstream/development and an mlrun-ce style Helm chart repo, so the git commands need adapting elsewhere
  • The embedded checklist is specific to the MLRun CE template and is not portable to other projects as-is
  • Items requiring real testing, QA sign-off, or Jira access are always left unchecked, so human review is still required
When to use it

Use it when a Helm chart branch is ready and you need a complete PR description with breaking-change detection written quickly.

When not to use it

Avoid it on repositories that are not Helm charts or whose base branch is not upstream/development, or when you want a free-form PR description instead of a fixed template.

Security analysis

Safe
Quality score88/100

The skill only runs read-only git commands (git diff and git log) scoped to a development branch, with no destructive operations, network exfiltration, or sensitive data access. The allowed tools match the declared tools and pose no meaningful execution risk.

No concerns found

Examples

Generate PR description for current branch
Analyze my current branch against upstream/development and write the full PR description, flagging any breaking changes.
Check chart version bump
Look at the diff on this branch and tell me whether Chart.yaml was bumped and whether the README needs updating for the new NodePort.
Draft title and description
Produce a [Scope] PR title and a filled PR template for these Helm chart changes, with a concrete list of changed values keys.

name: pr description: Analyze branch changes and generate a fully filled PR description ready to paste into GitHub allowed-tools: Bash(git diff*) Bash(git log*) disable-model-invocation: false

Analyze the current branch changes and generate a fully filled PR description ready to paste into GitHub.

Steps

  1. Gather context — run these in parallel:

    • git diff upstream/development...HEAD — full diff against the base branch
    • git log upstream/development..HEAD --oneline — commit list
    • git diff upstream/development...HEAD --name-only — changed files
  2. Analyze the diff carefully:

    • What components or templates were changed? (check which templates/ subdirs, values.yaml sections, requirements.yaml, Chart.yaml)
    • Were any new values keys added? Do they need to be reflected in the three install-mode values files?
    • Were any Secrets, ConfigMaps, or port numbers changed? (potential breaking changes)
    • Was Chart.yaml version bumped? If not, flag it.
    • Were requirements.yaml or requirements.lock changed?
    • Does charts/mlrun-ce/README.md need updating (new NodePort, new component, new install step)?
  3. Detect breaking changes — flag as breaking if any of:

    • A value key was renamed or removed
    • A Secret or ConfigMap name changed
    • A NodePort number changed
    • A sub-chart was upgraded with a major version bump
    • The storage credentials structure changed
    • Any hook annotation or hook-weight changed in a way that affects upgrade order
  4. Provide an optional PR title following the [Scope] description format, where Scope is one of: ['feature', 'fix', 'docs', 'improvement', 'revert', 'breaking', 'ci']. For example: [Feature] Add Redis support to mlrun-ce.

  5. Fill the PR template — produce the complete filled template below. Be specific and concrete; do not use placeholder text.


Apply these checklist rules before writing the output:

  • [x] — you can confirm this item is satisfied from the diff alone
  • [ ] — requires human action, judgment, or external system access

Specific rules:

  • "tested" → always [ ]
  • "documentation PR" → always [ ]
  • "QA tests / Jira ticket" → always [ ]
  • "installation verified" → always [ ]
  • Chart.yaml version bump → [x] if diff shows version changed, otherwise [ ] and add to Warnings
  • Multi-namespace values files → [x] if all three are in the diff OR the change has no effect on install-mode values; [ ] with a note if a new value was added only to values.yaml
  • README update → [x] if charts/mlrun-ce/README.md is in the diff OR no new NodePorts/components were added; otherwise [ ]

Output exactly this structure with real content (no placeholder text):

### 📝 Description
<2-4 sentences: what changed, why, and what it affects>

---

### 🛠️ Changes Made
<concrete bullet list — file paths, value keys, resource names>

---

### ✅ Checklist
- [ ] I have tested the changes in this PR
- [ ] I confirmed whether my changes require a change in documentation and if so, I created another PR in MLRun for the relevant documentation.
- [ ] I confirmed whether my changes require changes in QA tests, for example: credentials changes, resources naming change and if so, I updated the relevant Jira ticket for QA.
- [ ] I increased the Chart version in `charts/mlrun-ce/Chart.yaml`.
- [ ] I confirmed that the installation works both on a local Docker Desktop environment and on a real cluster when using the required [prerequisites](https://docs.mlrun.org/en/stable/install-mlrun-ce/kubernetes-install.html#prerequisites).
  - [ ] If installation issues were found, I updated the relevant Jira ticket with the issue and steps to reproduce, or updated the prerequisites documentation if the issue is related to missing or outdated prerequisites.
- [ ] If needed, update https://github.com/mlrun/ce/blob/development/charts/mlrun-ce/README.md with the relevant installation instructions and version Matrix.
- [ ] If needed, update the following values files for multi namespace support:
  - [ ] [Admin values](https://github.com/mlrun/ce/blob/development/charts/mlrun-ce/admin_installation_values.yaml)
  - [ ] [User values Node Port](https://github.com/mlrun/ce/blob/development/charts/mlrun-ce/non_admin_installation_values.yaml)
  - [ ] [User values ClusterIP](https://github.com/mlrun/ce/blob/development/charts/mlrun-ce/non_admin_cluster_ip_installation_values.yaml)

---

### 🧪 Testing
<what was tested: lint, helm template dry-run, Kind cluster, manual — based on nature of changes>

---

### 🔗 References
- Ticket link:
- External links:
- Design docs links (Optional):

---

### 🚨 Breaking Changes?

- [ ] Yes (explain below)
- [ ] No

<if breaking: bullet list of what downstream consumers must change — value keys to rename, Secrets to recreate, ports to update>

---

### 🔍️ Additional Notes
<follow-up tasks, known issues, affected areas — omit if nothing to add>

Then replace each [ ] with [x] on items you can confirm from the diff, following the rules above.

After outputting the filled template, add a short "Warnings" section (outside the template) listing anything that needs human attention before opening the PR (missing version bump, unsynced values files, potential breaking changes, etc.).

Between every sentence that ends with a . add two new lines to make it more readable.

Related skills