Skip to content

[docs] Document how to require a plugin #3552

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Jun 27, 2025
Merged

[docs] Document how to require a plugin #3552

merged 3 commits into from
Jun 27, 2025

Conversation

stephenfin
Copy link
Contributor

@stephenfin stephenfin commented Jun 27, 2025 •
edited
Loading

Add docs explaining how a user can "require" a plugin by taking advantage of tox's auto-provisioning functionality.

In addition:

  • explain how plugins are found and loaded;
  • retitle the "Extending tox" document to "Plugins", for easier discovery from the ToC; and
  • mark the [tox] min_version option as deprecated in favour of [tox] requires in the docs (but not at runtime as there is minimal cost to keeping it around)

Closes #3553.

  • ran the linter to address style issues (tox -e fix)
  • wrote descriptive pull request text
  • ensured there are test(s) validating the fix
  • added news fragment in docs/changelog folder
  • updated/extended the documentation

@stephenfin
docs: Allow version_deprecated option
29b5295 
We also remove the unused 'version_changed' option.

Signed-off-by: Stephen Finucane <[email protected]>
@stephenfin stephenfin marked this pull request as ready for review June 27, 2025 11:53
@stephenfin stephenfin requested a review from gaborbernat as a code owner June 27, 2025 11:53
stephenfin
stephenfin commented Jun 27, 2025
View reviewed changes
@stephenfin
tox: Soft-deprecate '[tox] min_version'
a41f77f 
We don't raise a warning or similar: this is purely to encourage new
users (and existing users reworking their tox.ini files) to prefer
'[tox] requires'.

Signed-off-by: Stephen Finucane <[email protected]>
@stephenfin
docs: Explain use of auto-provisioning for required plugins
5134f5d 
Signed-off-by: Stephen Finucane <[email protected]>
gaborbernat
gaborbernat approved these changes Jun 27, 2025
View reviewed changes
Copy link
Member

@gaborbernat gaborbernat left a comment

Choose a reason for hiding this comment

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

@gaborbernat gaborbernat merged commit 452c174 into tox-dev:main Jun 27, 2025
28 checks passed
@stephenfin stephenfin deleted the plugin-reqs branch June 27, 2025 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gaborbernat gaborbernat gaborbernat approved these changes

Assignees
No one assigned
Labels
bot:chronographer:provided
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document how to require plugins
2 participants
@stephenfin @gaborbernat