OpenParable
Skip to content
← Back to skills

Amdsmi Changelog Automation

Documents
amdsmi-changelog-automation

Amdsmi Changelog Automation is an Agent Skill for documents published in the ROCm/rocm-systems repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Check and generate changelog entries for amd-smi. Use when: reviewing PRs for changelog updates, generating release notes, checking CHANGELOG.md compliance.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/ROCm/rocm-systems/blob/HEAD/projects/amdsmi/.claude/skills/amdsmi-changelog-automation/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/amdsmi-changelog-automation, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Changelog Automation — amd-smi

Verifies changelog entries exist for meaningful changes and helps generate them.

Changelog Location

CHANGELOG.md in the workspace root.

When a Changelog Entry is Required

Change TypeRequired?Section
New public API function✅ YesAdded
Bug fix✅ YesFixed
Breaking API change✅ YesChanged (+ migration note)
Performance improvement✅ YesChanged
New CLI flag/subcommand✅ YesAdded
Build system fix⚠️ If user-visibleFixed
Internal refactor (no behavior change)❌ No—
Test-only changes❌ No—
Documentation-only changes❌ No—
Style/formatting-only changes❌ No—

Entry Format

Follow Keep a Changelog format:

## [Unreleased]

### Added
- New `amdsmi_get_gpu_<feature>()` API for querying <feature>

### Fixed
- Fixed `amd-smi metric` crash when NIC device not present

### Changed
- `amdsmi_get_gpu_temperature()` now returns temperature in millidegrees (breaking change)

Rules

  • One bullet per logical change (not per file)
  • Start with the affected component: API name, CLI subcommand, or module
  • For breaking changes: include migration guidance
  • Use past tense for fixes ("Fixed"), present tense for additions ("New")
  • Reference the JIRA/issue if available: [SWDEV-XXXXXX]
  • Bolded headline bullets must end with two trailing spaces (Markdown hard line break) so Sphinx renders the headline and its sub-bullets on separate lines. Example: 
    - **Fixed `amd-smi static` hang on gfx1153**.··
  - Added 60-second timeout to `amdsmi_init()`.
    (·· = two literal trailing spaces.) Without them, Sphinx collapses the headline into the first sub-bullet. Verify with grep -nP '^- \*\*.*\*\*[^ ]*$' CHANGELOG.md — any match is missing the trailing whitespace.

Review Checklist

When reviewing a PR, check:

  • CHANGELOG.md updated if change is user-visible
  • Entry is in the correct section (Added/Fixed/Changed/Removed)
  • Entry describes the impact, not the implementation
  • Breaking changes have migration notes
  • Entry is under ## [Unreleased] (not a version number)
  • Bolded headline bullets end with two trailing spaces (Sphinx hard break)

Severity

FindingSeverity
Missing changelog for new public API⚠️ IMPORTANT
Missing changelog for breaking change❌ BLOCKING
Missing changelog for bug fix⚠️ IMPORTANT
Changelog entry in wrong section💡 SUGGESTION
Missing changelog for internal-only changeNot a finding