skills.rest
Arize-ai
Arize-aiOFFICIAL
Explore all skills by this author →
Website𝕏@arizeaiGitHub

phoenix-release-notes

Generate Phoenix release documentation from analyzed commits and GitHub releases.

11.3k|1.1k|Updated Nov 9, 2022
Search Tags:#release notes#mdx#Technical Writing#Documentation#Phoenix#GitHub Releases#ChangeLog
One-click install
npx skills add https://github.com/Arize-ai/phoenix --skill phoenix-release-notes
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: phoenix-release-notes
Source: https://github.com/Arize-ai/phoenix/tree/main/.agents/skills/phoenix-release-notes
Command: npx skills add https://github.com/Arize-ai/phoenix --skill phoenix-release-notes

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writing accurate Phoenix release notes requires manually reviewing commits, reading changed code, and updating multiple documentation files, which is slow and error-prone. This Skill automates the full workflow from identifying undocumented releases to publishing MDX pages.

Core Features & Use Cases

  • Release Gap Detection: Compares GitHub releases against existing docs to find undocumented versions across all Phoenix packages (server, Python SDK, TypeScript SDK, evals, OTel).
  • Code-Grounded Analysis: Reads actual changed files rather than relying on commit messages, classifying changes as user-facing or internal housekeeping.
  • Multi-Touchpoint Publishing: Creates dated MDX files, updates the aggregate release-notes page, year overview cards, docs.json navigation, and optionally GitHub release descriptions.
  • Use Case: After a week of Phoenix releases, ask the Skill to document them; it consolidates the changes into one well-organized release notes page with verified code examples and a Slack-ready summary.

Quick Start

Write release notes for all undocumented Phoenix releases since the last documented date.

Frequently Asked Questions about phoenix-release-notes

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

FAQPage Schema
How do I write release notes for a Phoenix release?▼

Run the Skill to identify undocumented releases via gh release list, analyze the commits by reading changed code, then draft MDX files and update the aggregate page, year overview, and docs.json navigation. It handles the full publishing workflow end to end.

How do I find undocumented Phoenix releases?▼

The Skill compares gh release list output against existing files in docs/phoenix/release-notes/ and the ReleaseUpdate labels in release-notes.mdx. Any release without corresponding documentation coverage is flagged for writing.

Which Phoenix packages are covered by the release notes?▼

Coverage includes arize-phoenix server, arize-phoenix-client, arize-phoenix-evals, arize-phoenix-otel, and the TypeScript packages phoenix-client, phoenix-cli, phoenix-evals, phoenix-mcp, and phoenix-otel. Version lines list every affected package.

What changes get excluded from release notes?▼

Dependency bumps, internal refactors, test changes, CI/CD updates, and reverted features are excluded. If a release contains only these housekeeping changes, no release note is written at all.

Should each release get its own release notes page?▼

No, the default is one consolidated multi-topic file per batch of releases spanning a short window or shared theme. Only genuinely major features or breaking changes get standalone pages.

Can the Skill update GitHub release descriptions?▼

Yes, but only when explicitly requested. It preserves the existing release-please changelog body by wrapping it in a details block and prepending a highlights section with a link to the published notes.

Related Skills

Explore More Software Engineering Skills→
dwmkerrdwmkerr
23

release-please-development

Automates version bumps, changelog generation, and GitHub releases via Release Please.

Community
Intermediate
openaiopenai
5.0k

slack

Summarize Slack channels and threads and draft mrkdwn-formatted messages.

Official
Intermediate
snhrmsnhrm

library-release-checker

Identify breaking changes and deprecations from library release notes.

Community
Advanced
fxfx
8

update-description

Generate release-note summaries for GitHub Releases from changelog and PR bodies.

Community
Advanced