Skip to content

Release checklist

Note

While automation handles most of the release process, some project-specific details require manual updates.

README

  1. Update Features section with ~5 key points.

  2. Keep Usage clear and concise.

  3. Add __Examples__:

    1. Basic usage

    2. Common task

    3. Advanced/expert-level usage

Caution

Review README after changes to ensure coherence.

pyproject.toml

Caution

Do not edit sections starting with DO NOT EDIT UNTIL end marker and ending with [[[end]]].

  • [project.classifiers] – Add relevant PyPI classifiers ⧉.
  • [project.dependencies] and [project.optional-dependencies] – Double-check correctness.

Tip

For public projects after the first release, remove exclude_links in [tool.md_dead_link_check] to validate all links.

Documentation

Caution

Adjust /docs structure and content as needed.

You should consult the documentation guide for more details.

Note

Content in folders like /docs/tutorials is auto-included via mkdocs-awesome-pages ⧉ if any content is present there.

Caution

Manually validate mkdocs.yml and generated docs.

Security

Documents

  • Ensure ROADMAP.md outlines plans for the next release (if applicable).
  • Optional: Add more governance details to GOVERNANCE.md.