This repository was archived by the owner on Jul 22, 2026. It is now read-only.
chore: document deprecation in preparation for repo archival#1282
Merged
benhoyt merged 8 commits intoJul 22, 2026
Conversation
james-garner-canonical
marked this pull request as ready for review
July 22, 2026 05:18
dwilding
approved these changes
Jul 22, 2026
dwilding
left a comment
There was a problem hiding this comment.
I agree with this approach. Thanks for the explanation.
benhoyt
approved these changes
Jul 22, 2026
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR documents that
python-libjujuis deprecated, and that charms should use Jubilant for integration tests.README.rstis a symlink todocs/readme.rst, which now has a deprecation notice at the top.docs/index.rstincludes the readme, so the notice shows on the docs homepage too (preview)Additionally the readme is update to fix a slight formatting error (missing newline) and document 24.04 as the last supported base.
Please use the text above this line as the commit message.
See below for additional context.
I experimented with having a deprecation notice on every docs page, which worked fine locally, but I couldn't get it past RTD's incremental docs builder to show up in the preview build, so I've gone with just the readme + homepage update.
Pushing this information to PyPI is not included in this PR, as that would require a new release of
python-libjuju, which probably sends the wrong message. If we did want to push the notice to PyPI, we'd need to bump the library version and make a library release -- typically this would be a.post0release, as it's metadata only, though we'd want to dig and make sure that no one is implementing any funky version parsing (the current version is3.6.1.3, which appears to bejuju-major.juju-minor.juju-patch.python-libjuju-release-counter, and is exposed asjuju.version.CLIENT_VERSION).If we did want to make a library release, we could consider updating the package docstring to include the deprecation notice, and perhaps even adding a runtime deprecation warning (though this is probably a bad idea since use of
python-libjujuisn't confined to integration tests).Ultimately I don't recommend making a library release at this time.
The integration test failures are certainly unrelated, and I refuse to look at them.
The Jenkins check URL returns "Bad Request" after 2FA. I don't think it's worth trying to fix Jenkins for this project (again), so if we can bypass that check to merge that would be great.