docs/contributing/gauging_changes.md

   1 # Gauging changes
   2
   3 A lot of the time, your change will affect formatting and/or performance. Quantifying
   4 these changes is hard, so we have tooling to help make it easier.
   5
   6 It's recommended you evaluate the quantifiable changes your _Black_ formatting
   7 modification causes before submitting a PR. Think about if the change seems disruptive
   8 enough to cause frustration to projects that are already "black formatted".
   9
  10 ## diff-shades
  11
  12 diff-shades is a tool that runs _Black_ across a list of Git cloneable OSS projects
  13 recording the results. The main highlight feature of diff-shades is being able to
  14 compare two revisions of _Black_. This is incredibly useful as it allows us to see what
  15 exact changes will occur, say merging a certain PR.
  16
  17 For more information, please see the [diff-shades documentation][diff-shades].
  18
  19 ### CI integration
  20
  21 diff-shades is also the tool behind the "diff-shades results comparing ..." /
  22 "diff-shades reports zero changes ..." comments on PRs. The project has a GitHub Actions
  23 workflow which runs diff-shades twice against two revisions of _Black_ according to
  24 these rules:
  25
  26 |                       | Baseline revision       | Target revision              |
  27 | --------------------- | ----------------------- | ---------------------------- |
  28 | On PRs                | latest commit on `main` | PR commit with `main` merged |
  29 | On pushes (main only) | latest PyPI version     | the pushed commit            |
  30
  31 Once finished, a PR comment will be posted embedding a summary of the changes and links
  32 to further information. If there's a pre-existing diff-shades comment, it'll be updated
  33 instead the next time the workflow is triggered on the same PR.
  34
  35 The workflow uploads 3-4 artifacts upon completion: the two generated analyses (they
  36 have the .json file extension), `diff.html`, and `.pr-comment.json` if triggered by a
  37 PR. The last one is downloaded by the `diff-shades-comment` workflow and shouldn't be
  38 downloaded locally. `diff.html` comes in handy for push-based or manually triggered
  39 runs. And the analyses exist just in case you want to do further analysis using the
  40 collected data locally.
  41
  42 Note that the workflow will only fail intentionally if while analyzing a file failed to
  43 format. Otherwise a failure indicates a bug in the workflow.
  44
  45 ```{tip}
  46 Maintainers with write access or higher can trigger the workflow manually from the
  47 Actions tab using the `workflow_dispatch` event. Simply select "diff-shades"
  48 from the workflows list on the left, press "Run workflow", and fill in which revisions
  49 and command line arguments to use.
  50
  51 Once finished, check the logs or download the artifacts for local use.
  52 ```
  53
  54 [diff-shades]: https://github.com/ichard26/diff-shades#readme