Skip to content

Add support for future-version workflows #468

Open
@jaraco

Description

@jaraco

In python/cpython#93965, I'm realizing that it would be nice when deprecating some functionality to simultaneously submit the changes to remove the deprecated behavior. That is, it would be nice to be able to author an issue and/or PR that targets Python N+.1 or N+.2 (where Python N is what's on main).

I think such a workflow could be readily achieved by:

  • Add tags for future versions (e.g. 3.13, 3.14) to Github.
  • Add a tag for deferred work (maybe call it "deferred").
  • Advise developers to close deferred items until they're valid.
  • When main is updated for a new version, re-open deferred tickets for the new version.

Other features could be added to streamline the process.

  • Automatically create new tags two versions into the future.
  • Disallow merging of "deferred" PRs.
  • Automatically close deferred items that aren't yet valid.
  • Automatically re-open deferred tickets when new branches are created (i.e. creation of 3.11 branch would re-open 3.12 deferred items).

This process would enable contributors to scope out a full lifecycle of a deprecation in a single bug with a couple of stacked PRs, one that is merged immediately and another that is deferred until the codebase is ready. This approach has the advantage of implementing the changes near to each other, avoiding loss of context in the interim, and offering a review of both changes together.

Except for initial setup, this process would require a tiny bit of extra work when cutting each new minor release.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions