Skip to content

Conversation

StanFromIreland
Copy link
Member

@StanFromIreland StanFromIreland commented Sep 17, 2025

Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Let's also move this before the slower sphinx-lint.

hooks:
- id: oxipng
args: [--strip=safe, --alpha]
# Exclude all existing pngs
Copy link
Member

Choose a reason for hiding this comment

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

Is it all existing pngs, or a subset?

Copy link
Member Author

Choose a reason for hiding this comment

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

All, however, it would just save off a byte or two for a few.

Copy link
Member

Choose a reason for hiding this comment

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

I really don't think we want to exclude all existing images, that will severely reduce the usefulness of the new check. After all, the most likely changes are going to be to existing images to update them.

Does anyone know why we use --all-files in the CI pre-commit check? Surely it would be better to make use of --from-ref and --to-ref?

Copy link
Member

Choose a reason for hiding this comment

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

Alternately, we should just take the hit once to enable the check and optimize the snot out of everything in this PR with no exclude list.

Copy link
Member

Choose a reason for hiding this comment

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

Optimising exisiting PNGs has some benefit, but results in a larger repo size. The only user-visible effects should be in the documentation, where we'd preferably use SVGs to PNGs (especially for diagrams etc).

Personally, I think this check would probably cost more than it saves (at least on a macro scale), but I don't have a strong opinion, I don't use pre-commit.

@mhsmith mhsmith removed their request for review September 29, 2025 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants