Pre Release

Pre-Release Workflow

{REPO} = https://github.com/ZhuoZhuoCrayon/throttled-py

Input Format

# With release draft URL
release v3.2.0 {REPO}/releases/tag/untagged-xxxxx

# With changelog content directly
release v3.2.0
<paste release draft content here>

Workflow Overview

flowchart TD
    A[Parse Input] --> B[Get Release Changelog]
    B --> C[Update Version Numbers]
    C --> D[Update CHANGELOG_EN.rst]
    D --> E[Translate & Update CHANGELOG.rst]
    E --> F[Sync Dependencies]
    F --> G[Verification]

Step 1: Parse Input

Extract from user input:

• Version: vX.Y.Z → X.Y.Z
• Release Date: Use today's date (YYYY-MM-DD)
• Changelog: From URL or directly provided content

Step 2: Get Release Changelog

• If URL provided: Fetch content from the release draft URL
• If content provided: Use the changelog content directly
• If neither accessible: Ask user to provide the content

Step 3: Update Version Numbers

Update version string in these files:

Step 4: Update CHANGELOG_EN.rst

Insert new entry after the title section:

vX.Y.Z - YYYY-MM-DD
---------------------

`简体中文 (vX.Y.Z) <{GITHUB_REPOSITORY}/blob/main/CHANGELOG.rst#vxyz---YYYY-MM-DD>`_ | English

**{emoji} {category_title}**

- {change_entries}

**Full Changelog**: {GITHUB_REPOSITORY}/compare/vPREV...vX.Y.Z

Reference: Read .github/release-drafter-config.yml for:

• Category titles and their emojis
• Entry format template

Step 5: Translate & Update CHANGELOG.rst

Insert translated entry after the title section:

vX.Y.Z - YYYY-MM-DD
---------------------

`English Documents Available (vX.Y.Z) <{GITHUB_REPOSITORY}/blob/main/CHANGELOG_EN.rst#vxyz---YYYY-MM-DD>`_ | 简体中文

**{emoji} {category_title_zh}**

- {translated_change_entries}

**完整更新日志**: {GITHUB_REPOSITORY}/compare/vPREV...vX.Y.Z

Translation Reference

Common Translations

Note: Preserve technical terms, @author mentions, and PR numbers.

Step 6: Sync Dependencies

Run the following command to update uv.lock:

uv lock

This ensures uv.lock reflects the updated version in pyproject.toml.

Step 7: Verification

• Version numbers consistent across all 3 files
• uv.lock updated successfully
• Cross-references between EN/ZH changelogs are correct
• RST anchor format: #vxyz---YYYY-MM-DD (no dots, lowercase)
• All categories from release draft included
• Only include sections that have content
• CRITICAL At the beginning of the verification summary, include:

  ✓ Conducted skill defined in .agents/skills/pre-release/SKILL.md.

Format Reference

Refer to existing entries in CHANGELOG.rst and CHANGELOG_EN.rst for exact formatting.