Skip to content

maint: use pytest-cov, cleanup docs/requirements.txt, and reduce rate limiting issues in CI#169

Merged
consideRatio merged 5 commits intoexecutablebooks:mainfrom
consideRatio:pr/misc
May 7, 2026
Merged

maint: use pytest-cov, cleanup docs/requirements.txt, and reduce rate limiting issues in CI#169
consideRatio merged 5 commits intoexecutablebooks:mainfrom
consideRatio:pr/misc

Conversation

@consideRatio
Copy link
Copy Markdown
Collaborator

@consideRatio consideRatio commented May 7, 2026

  • We had both the optional sphinx install target side by side with docs/requirements.txt and they had also gone out of sync. With this change, we remove docs/requirements.txt and lean on the pyproject.toml's defined requirements.
  • pytest-cov added in order to understand better how much test coverage we had in various files
  • bumped python 3.13 environment in ci to 3.14
  • removed use of @choldgraf read-only PAT secret
  • did some interventions to reduce api rate limiting

AI disclosure

codex and its GPT 5.5 model was used to determine the state of things, and wrote the concurrency / max-parallel parts in the CI. Inline comments are my own, and everything else.

@consideRatio consideRatio changed the title wip: towards fixing failures in main maint: use pytest-cov, cleanup docs/requirements.txt, and reduce rate limiting issues in CI May 7, 2026
Comment thread pyproject.toml
"myst_parser",
"sphinx_book_theme",
"sphinx>=5",
"sphinx-design",
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

this was part of docs/requirements.txt, but not here, so I added it here.

Comment on lines -38 to -40
# Use TOKEN_READONLY if available (pushed branches), otherwise use GITHUB_TOKEN (PRs)
# TOKEN_READONLY is a PAT for @choldgraf that only has read-access to this repo but isn't available in PRs.
GITHUB_ACCESS_TOKEN: "${{ secrets.TOKEN_READONLY || secrets.GITHUB_TOKEN }}"
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Use of this token failed in another way then using the workflow's github.token (aka secrets.GITHUB_TOKEN), so instead of debugging it etc, I removed it and reduced the burden on rate limiting to stabilize things that way.

@consideRatio consideRatio marked this pull request as ready for review May 7, 2026 06:48
@consideRatio consideRatio requested a review from nabobalis May 7, 2026 06:48
@consideRatio
Copy link
Copy Markdown
Collaborator Author

Got time for more review @nabobalis? ❤️ 🎉

I'd also love to help do a release with #166, and if so, do we use version 1.1.6? I added a bug label to it.

Copy link
Copy Markdown
Member

@choldgraf choldgraf left a comment

Choose a reason for hiding this comment

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

This all looks pretty clean to me! So you're reducing the number of parallel builds in order to lessen the API hits, and removing my read-only token in the process. I think that's safe to try and maybe we can optimize further if we start failing CI because we hit the rate limit.

@consideRatio
Copy link
Copy Markdown
Collaborator Author

Use of your CI token failed in some other way, i didnt look into and figure out why, but perhaps it didnt have all the required permissions when it started to inspect github releases or something.

@consideRatio
Copy link
Copy Markdown
Collaborator Author

Thank you both for helping out with reviews @choldgraf and @nabobalis!

@consideRatio consideRatio merged commit db607da into executablebooks:main May 7, 2026
5 checks passed
@choldgraf
Copy link
Copy Markdown
Member

To be clear I would love to not use my tokens at all haha so I'm a big fan of this. I added it a few months back because I was getting horrifically frustrated with our CICD haha

@consideRatio
Copy link
Copy Markdown
Collaborator Author

All green in main :D

@choldgraf
Copy link
Copy Markdown
Member

omg quick don't touch anything 😅

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.

2 participants