Skip to content
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 into
juju:mainfrom
james-garner-canonical:26-06+chore+archive-repo
Jul 22, 2026
Merged

chore: document deprecation in preparation for repo archival#1282
benhoyt merged 8 commits into
juju:mainfrom
james-garner-canonical:26-06+chore+archive-repo

Conversation

@james-garner-canonical

@james-garner-canonical james-garner-canonical commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

This PR documents that python-libjuju is deprecated, and that charms should use Jubilant for integration tests.

  • Github: README.rst is a symlink to docs/readme.rst, which now has a deprecation notice at the top.
  • RTD: docs/index.rst includes 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 .post0 release, 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 is 3.6.1.3, which appears to be juju-major.juju-minor.juju-patch.python-libjuju-release-counter, and is exposed as juju.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-libjuju isn'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.

Comment thread docs/conf.py Outdated
@james-garner-canonical
james-garner-canonical marked this pull request as ready for review July 22, 2026 05:18

@dwilding dwilding left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I agree with this approach. Thanks for the explanation.

@benhoyt
benhoyt merged commit 562aed0 into juju:main Jul 22, 2026
13 of 29 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants