Repository navigation
🚀 Feature: Official GitHub Action for pyDeprecate Validation #93
Description
Is your feature request related to a problem?
With the recent introduction of Validating wrapper configuration and the ongoing work to extend the developer toolbox (specifically PR #89 and PR #90), pyDeprecate is evolving from a runtime library into a tool suite that includes static verification.
Currently, to utilize these new validation tools in a CI/CD pipeline, developers must manually configure shell scripts to invoke the Python module. It would be much more natural and user-friendly if these tools were integrated into a plug-and-play GitHub Action.
Describe the solution you'd like
I propose creating a dedicated GitHub Action that wraps the new developer toolbox.
This would allow maintainers to easily add pyDeprecate checks to their CI suite, ensuring that deprecation wrappers are valid and consistent across the project without complex shell scripting.
Proposed workflow usage:
steps:
- uses: actions/checkout@v4
- name: Run pyDeprecate Validation
uses: Borda/pyDeprecate-action@main
with:
# Example arguments based on the new CLI tools
path: "my_package/"
fail_on_warning: trueDescribe alternatives you've considered
The current alternative is invoking the tools via standard shell commands in the CI workflow (e.g., python -m pydeprecate.tools ...). While functional, a dedicated Action improves discoverability in the Marketplace and simplifies configuration for end-users.
Additional context
- Existing Validation Feature: README - Validating wrapper configuration
- Related Tooling PRs: Add deprecation expiry enforcement with module and package-level checking and auto-version detection #89 and Add validate_deprecation_chains utility to scan modules for lazy deprecated wrappers #90
This integration would complete the "developer experience" loop for the new tooling capabilities.
Activity
uahroberto commentedon Feb 1, 2026
Hi @Borda! 👋
I really like the direction this project is taking and I would love to help implement this feature.
I can create a Composite GitHub Action (action.yml) that wraps the new CLI tools as described. This would allow users to easily plug it into their workflows.
Quick question: Would you prefer I submit a PR with the action.yml directly to this repository, or is the plan to host it in a separate repository (e.g., Borda/pyDeprecate-action)?
Borda commentedon Feb 1, 2026
Will need to think if there is an adventage for project of this scale (very small and focused) have action in separate repo... So far I keen to keep all in the same...
uahroberto commentedon Feb 2, 2026
Sounds good.
I will work on creating the actions.yml in this repository. I'll open a PR shortly so we can review the implementation details.
Borda commentedon Feb 2, 2026
Let's hold a bit until all the dev features lands...
uahroberto commentedon Feb 2, 2026
Alright, text me back when everything is ready and we’ll move forward with it
Borda commentedon Feb 25, 2026
@uahroberto I think it's good to go... :)
fix(tests): replace `...` with `pass` in classmethod body — CodeQL clean