managing-python-releases

Python 发布管理

语义化版本

MAJOR.MINOR.PATCH (e.g., 1.2.3)

PATCH: Bug fixes, no API changes
MINOR: New features, backward compatible
MAJOR: Breaking changes

变更日志格式（Keep a Changelog）

# Changelog

## [Unreleased]
### Added
- New `batch_encode()` function

## [1.2.0] - 2024-03-15
### Added
- Support for custom formats (#123)

### Fixed
- Edge case at -180 longitude (#145)

### Deprecated
- `old_function()` - use `new_function()` instead

[Unreleased]: https://github.com/user/repo/compare/v1.2.0...HEAD
[1.2.0]: https://github.com/user/repo/releases/tag/v1.2.0

类别： Added、Changed、Deprecated、Removed、Fixed、Security

代码中的版本

# src/package/__init__.py
__version__ = "1.2.3"

# Or use importlib.metadata
from importlib.metadata import version
__version__ = version("my-package")

GitHub Actions 发布

由标签触发的工作流使用 uv 构建，并通过可信发布（不存储令牌）发布到 PyPI。完整的规范流水线——TestPyPI 试运行、GitHub 发布以及发布运行手册——见 AUTOMATION.md。

# .github/workflows/release.yml
on:
  push:
    tags: ['v*']

jobs:
  release:
    runs-on: ubuntu-latest
    permissions:
      contents: write      # create the GitHub release
      id-token: write      # trusted publishing (no token)
    steps:
      - uses: actions/checkout@v4
      - uses: astral-sh/setup-uv@v5
      - run: uv build
      - uses: softprops/action-gh-release@v2
        with:
          files: dist/*
      - uses: pypa/gh-action-pypi-publish@release/v1

弃用流程

使用 stacklevel=2 发出警告，使消息指向调用方。参数、类或整个模块的弃用，以及迁移指南模板，详见 MIGRATION.md。

import warnings

def old_function():
    """Deprecated: Use new_function() instead."""
    warnings.warn(
        "old_function() deprecated, will be removed in 2.0.0",
        DeprecationWarning,
        stacklevel=2,
    )
    return new_function()

发布流程

# 1. Update CHANGELOG.md (move Unreleased to version)
# 2. Bump version in pyproject.toml and __init__.py
# 3. Commit and tag
git commit -am "Release v1.2.0"
git tag -a v1.2.0 -m "Release v1.2.0"
git push origin main --tags
# 4. CI publishes automatically

有关详细工作流，请参阅：

• AUTOMATION.md - 版本升级脚本
• MIGRATION.md - 迁移指南模板

检查清单

Before Release:
- [ ] All tests pass
- [ ] CHANGELOG updated
- [ ] Version bumped
- [ ] Documentation current

After Release:
- [ ] PyPI shows new version
- [ ] pip install works
- [ ] GitHub release created
- [ ] Docs updated

了解更多

此技能基于 Will McGinnis 撰写的 《高质量 Python 库开发指南》 中的 “维护” 部分。以下文章提供了更深入的介绍：

• 语义化版本