Skip to content

Guard users against upcoming Black incompatibilities #382

@akaihola

Description

@akaihola

The process for allowing Darker users to auto-update Black but still guard them against Darker/Black incompatibilities is:

  1. The test-future.yml workflow regularly tests Darker against the current main HEAD of Black
  2. Make a patch version release as soon as that workflow notifies about an upcoming incompatibility in Black. If that e.g. happened today, we'd release Darker 1.4.3 with a upper limit for the version of the Black dependency to the newest version known to work.
  3. Then, after we've fixed the incompatibility, make a new patch version with the fix and the upper version limit removed.

This way anyone specifying darker~=1.4 for their project, Darker would automatically update to 1.4.3 and prevent Black from updating to an incompatible version before we've released a fixed Darker 1.4.4 or 1.5.0.

  • Document darker~=x.y as the recommended way to depend on Darker
  • Update the test-future.yml workflow to point to the guidelines in this issue in case of a failure
  • Explain this process in the documentation

Originally posted by @akaihola in #334 (reply in thread)

Metadata

Metadata

Assignees

Labels

CIdocumentationImprovements or additions to documentation

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions