Skip to content

Repository files navigation

Staging ground for maintainers to collaborate on torch release notes. Houses various artifacts that chronicle the release notes starting with 2.7.

The file structure is as follows:

  • X.Y.Z/ (release version, e.g., 2.7.0)
    • done/ (contains all .mds containing completed release notes)
      • results_*.md
    • todo/ (contains all .mds containing in progress release notes, disjoint from done/)
      • results_*.md
    • commitlist.csv (contains all new commits in the release, this file is generated by a script)
    • final.md (the final coagulated release notes)
    • miscategorized.md (contains commits that were miscategorized)
  • .gitignore
  • final_template.md (a skeleton template for final.md)
  • LICENSE
  • README.md (this file)

For those editing release notes, you can use the Claude skill gen-release-notes to complete an individual worksheet.

For the release manager, the runbook is located here. The scripts for generating all the relevant artifacts are in https://github.com/pytorch/pytorch/tree/main/scripts/release_notes, or you can try using the gen-commitlist Claude skill.

Audit release-branch coverage

Use scripts/check_release_branch_coverage.py to compare the effective commits on a PyTorch release branch with the PRs and commit hashes referenced by this repository's worksheets, miscategorized list, and cherry-pick file:

python3 scripts/check_release_branch_coverage.py 2.14.0 \
  --pytorch-repo ../pytorch

By default, 2.14.0 compares v2.13.0 with origin/release/2.14. Pass --base-ref or --release-ref to override those refs, and --fetch to refresh the remote release branch first. Patches already present in the base release (for example, changes cherry-picked into 2.13) are identified with git cherry and canonical PR metadata, then excluded from the 2.14 coverage requirement. The PR fallback catches conflict-resolved and combined backports whose patch IDs do not match exactly.

The report highlights both sides of the set difference, references to changes canceled by reverts, repeated references to base-release changes, and reverts whose targets sit outside the comparison range. It exits nonzero for missing effective commits or user-facing references to reverted/base-release changes; --strict also treats note-only PR references as failures.

Use --json for machine-readable output.

This repo is BSD-3 licensed, see LICENSE for details.

About

Staging ground for pytorch/pytorch maintainers to collaborate on release notes for PyTorch releases. Houses the artifacts that chronicle each release.

Resources

Code of conduct

Contributing

Stars

3 stars

Watchers

6 watching

Forks

Releases

Packages

Used by

Contributors

Languages