Skip to content

Add CI for automatic mkdocstrings version bumps #2

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.

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

Open
ItsDrike opened this issue Feb 12, 2025 · 0 comments
Open

Add CI for automatic mkdocstrings version bumps #2

ItsDrike opened this issue Feb 12, 2025 · 0 comments
Labels
internal Changes to the private API or other internal parts

Comments

@ItsDrike
Copy link
Owner

One of the primary goals of this project is to improve the packaging and provide a more trustworthy package that won't break on end users. Because of that, the mkdocstrings dependency of this library is set to a fairly strict version range, with the upper bound being the most recently released mkdocstrings version that is verified to be supported.

This approach can be fairly tedious to maintain, as it would require keeping track with mkdocstrings releases and make updates manually. A nicer approach would be to make a CI workflow that would run on a cron timer, checking whether a newer release of mkdocstrings is available, running our unit-tests against that and automatically making at least a PR, but perhaps even a PyPI release.

@ItsDrike ItsDrike added feature New feature or request internal Changes to the private API or other internal parts and removed feature New feature or request labels Feb 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal Changes to the private API or other internal parts
Projects
None yet
Development

No branches or pull requests

1 participant