Menu
Draft professional and categorized release notes for ruff-sync using GitHub CLI, git history, and the `invoke release` task.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
Configure and operate ruff-sync to synchronize Ruff linter settings across Python projects. Use when the user wants to set up ruff-sync, sync Ruff config from an upstream source, check for configuration drift, integrate ruff-sync into CI, troubleshoot sync issues, or keep Ruff rules consistent across multiple repositories.
Handle python warnings properly by emitting them with warnings.warn, catching them in tests with catch_warnings, and translating them to errors if running in strict mode or via filterwarnings.
Use this skill to manage multiple versions of documentation for MkDocs-powered sites. Deploy new versions, update aliases (like 'latest' or 'stable'), set the default version for the site root, and manage versioned subdirectories in the deployment branch. Use this whenever the user wants to publish, version, or alias documentation, even if they don't explicitly mention "mike". Also use this when the user wants to troubleshoot or debug versioned documentation.
Build sophisticated Terminal User Interfaces (TUIs) in Python using an async, CSS-inspired framework.
Generate MkDocs documentation sites with Material theme, mkdocstrings for API docs, and versioning. Use when setting up or extending project documentation.
Systematic workflows for designing types, architecting classes, and resolving static type issues in Python 3.10. Trigger on "new class," "designing," "refactoring," or "mypy errors." Prioritizes healthy design (Generics, Protocols) over narrowing.
| name | release-notes-generation |
| description | Draft professional and categorized release notes for ruff-sync using GitHub CLI, git history, and the `invoke release` task. |
This skill guides you through drafting high-quality release notes for ruff-sync. It leverages the invoke release task and GitHub CLI for context.
gh): Must be authenticated.tasks.py.Before drafting, understand what has changed since the last release.
# Get the latest release tag and notes
gh release list --limit 1
gh release view <tag>
# List merged PRs since the last tag
# Replace <tag> with the tag found above
gh pr list --state merged --search "merged:><tag-date>"
# Or simple git log
git log <tag>..HEAD --oneline
Use the project's built-in release task to scaffold the release. This task automatically tags the release based on the version in pyproject.toml and uses GitHub's --generate-notes feature to create a starting point.
# Create a draft release (default behavior of invoke release)
uv run invoke release --draft --skip-tests
[!NOTE]
invoke releasewill:
- Check if you are on
main.- Check for clean git state.
- Create a GitHub Release with
--generate-notes.
GitHub's automatically generated notes are a good start but often lack professional categorization and narrative. Use the following structure for final refinement:
ruff_sync.README.md, docs/, or docstrings.[!WARNING] alerts).Once the notes are drafted and refined, you can view the draft on GitHub or update it via CLI.
# View the draft notes
gh release view v<version>
# Edit the draft (opens your editor)
gh release edit v<version> --notes "your new notes"
AGENTS.md for project-specific terminology (e.g., "Upstream Layers").