Skip to content

Conversation

@cobaltt7
Copy link
Collaborator

@cobaltt7 cobaltt7 commented Dec 29, 2025

Description

Various unrelated refactors, most of which are too small for their own PR

Since most changes are largely unrelated, it may be easier to review this PR commit-by-commit, so I made sure to keep each change contained to a single commit and I've listed them here:

  • 1a9dd77: Rename workflows, jobs, and steps for consistency, clarity, and correctness
  • fa7eb86: Set up dependency groups in pyproject.toml
  • f7fa155: Add and improve paths matchers on action triggers
  • 3a24345: Split up build workflow jobs into build and publish
  • 4b57124: Correct wrong/outdated information in release & build docs
  • b4bc004: Don't wrap prose in issue/PR templates
    • GitHub issue comments preserve all newlines
    • GitHub releases do as well, so this should maybe be expanded to include CHANGES.md too, but that would be a more intrusive change
  • 3a90881: Manually reformat places that don't get autoformatted
    • Most notably:
      • vim files (and Python heredocs)
      • Sphinx attestations
      • pyproject.toml
    • I used 4-space indents to be consistent with Black
    • Files formatted with Prettier are currently defaulting to 2-space indents, but I left that alone for now
  • 3df4eaf: Modfiy codeblock languages
    • Standardize /py(thon)?(3)?/ to python
    • Only use console when output is shown, because it's very lacking compared to sh
    • Add a few other missing languages
  • fe51bd0: Minor misc docs rewordings (and add myself to AUTHORS.md)
  • 7d9c7cb: Run docker builds in parallel using native builders
    • Cuts build times from ~45 to ~6 minutes
  • fa5faa7: Refactor diff-shades workflow
    • It still uses the workflow_run trigger unfortunately (see Lingering CI/CD pins, add cooldowns, remove template injections #4906); there's no way to comment on the PR without it
      • Having said that, I think the usage of this is "safe"
      • To my understanding, the worst someone could do is modify the comment to whatever they wanted
      • I don't think it'd be worth it to remove the comment functionality just to satisfy the linter
      • Also, a maintainer has to manually approve CI on PRs unless they've contributed before, so it'd be a fair amount of effort for someone to troll
    • Reword PR comment to be clearer and more detailed (example: cobaltt7-patch-1 cobaltt7/black#7 (comment))
    • Work around Prettier format issues
    • Update docs appropriately

all CI changes were tested as best I could

Checklist - did you ...

  • [-] Implement any code style changes under the --preview style, following the stability policy?
  • [-] Add an entry in CHANGES.md if necessary?
  • [-] Add / update tests if necessary?
  • [y] Add new / update outdated documentation?

@cobaltt7

This comment was marked as resolved.

@cobaltt7 cobaltt7 force-pushed the ci-refactors branch 2 times, most recently from a216316 to 7aa9f3a Compare December 29, 2025 22:43
@cobaltt7 cobaltt7 marked this pull request as draft December 30, 2025 00:40
@cobaltt7 cobaltt7 marked this pull request as ready for review December 31, 2025 20:34
Use them most places (some places are migrated in future commits)
Also bumps some action runner versions
And updates dependabot/pre-commit config to check for more updates

Signed-off-by: cobalt <[email protected]>
Most notably:
- vim files (and Python heredocs)
- Sphinx attestations
- pyproject.toml

Signed-off-by: cobalt <[email protected]>
- Standardize `/py(thon)?(3)?/` to `python`
- Only use `console` when output is shown, because it's very lacking compared to `sh`
- Add a few other missing languages

Signed-off-by: cobalt <[email protected]>
Cuts build times from ~45 to ~6 minutes
Reword PR comment to be clearer and more detailed
Work around Prettier format issues
Update docs appropriately

Signed-off-by: cobalt <[email protected]>
@cobaltt7
Copy link
Collaborator Author

cobaltt7 commented Jan 1, 2026

All issues have been fixed, ready for review!

Copy link
Collaborator

@hauntsaninja hauntsaninja left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! Looks good from a skim! (And happy new year! :-) )

```python
def f(
):
"Make sure this code is blackened"""
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "current Black style" needs to be Blackened, but the proposed desired style can be anything (also preexisting, but the triple quotes are mismatched :-) )

Maybe "This code should be formatted as per the current Black style" would be clearer

First clone the _Black_ repository:

```console
```sh
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does this syntax highlight well, given that we include the PS1 prompt?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip news Pull requests that don't need a changelog entry.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Split the Build and Publish workflow into more jobs

2 participants