Integrate tox-dev/workflow's reusable-tox.yml#1711
Merged
Conversation
Adds a top-level tox.ini and routes the build, lint, and metadata-validation jobs through tox-dev/workflow's reusable-tox.yml. The build-pure-python-dists job is replaced by a build job that runs the new build-dists tox env, lint becomes a matrix of pre-commit, spellcheck-docs, and build-docs through the reusable workflow, and a new metadata-validation job validates every built dist. MyPy coverage uploads to Coveralls from a post-tox-job hook; reusable-linters.yml is retired since its responsibilities have moved into the new layout. Mirrors aio-libs/propcache#243.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What do these changes do?
Adds a top-level
tox.iniand routes thebuild,lint,and
metadata-validationjobs throughtox-dev/workflow'sreusable-tox.yml. Thebuild-pure-python-distsjob isreplaced by a
buildjob that runs the newbuild-diststoxenv,
lintbecomes a matrix ofpre-commit,spellcheck-docs, andbuild-docsdriven by the reusableworkflow, and a new
metadata-validationjob validates everybuilt dist. MyPy coverage uploads to Coveralls from a
post-tox-jobhook, soreusable-linters.ymlis retired.Mirrors aio-libs/propcache#243.
Are there changes in behavior for the user?
No. CI-only change; end-user-visible behavior of
yarlisunaffected.
Is it a substantial burden for the maintainers to support this?
No; the new layout matches the one already in flight in
aiosignalandpropcache.Related issue number
N/A; tracks aio-libs/propcache#243.
Checklist
CHANGES/folderAgent run details (optional, for reviewers)
Drafted with Claude Code (Opus 4.7); reviewed by @bdraco.
Local verification on macOS:
tox r -e build-distsproducesyarl-1.23.0.tar.gzandyarl-1.23.0-py3-none-any.whlindist/.tox r -e metadata-validationpasses on both dists.tox r -e build-docsbuilds the Sphinx HTML output.tox r -e pre-commit -- <hook>exercises sampled hooks(
yamllint,check-yaml,actionlint,check-github-workflows,check-github-workflows-timeout,file-contents-sorter,rst-linter,cython-lint,flake8,end-of-file-fixer,trailing-whitespace,codespell) and they pass.tox r -e spellcheck-docsreproduces pre-existing macOS-onlyHunspell divergence on words like
quoterandunobviousthat the Linux dictionary already accepts on master; my new
CHANGES/1711.contrib.rstfragment is clean.Scope intentionally narrow:
pre-commit,spellcheck-docs, andbuild-docs.doctest-docsis defined intox.inibutnot wired into the matrix because
docs/index.rsthas real.. doctest::directives that needyarlinstalled; theinstall plumbing is a follow-up.
cibuildwheeltest and benchmark jobs are untouched.