feat(charmlibs): warn of deprecation on all charmlibs commands - #2691
Merged
Conversation
Warns about the deprecation of charmhub-hosted charmlibs in all charmlibs-related commands.
Collaborator
Author
|
@tonyandrewmeyer @james-garner-canonical pls review |
Contributor
|
Type checking with Command output |
Contributor
|
Type checking with Command output |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a user-visible deprecation notice for Charmhub-hosted charm libraries across the “Store (libraries)” command set, ensuring users see the warning regardless of which charmlibs-related subcommand they run.
Changes:
- Introduces a shared
CHARMLIBS_DEPRECATION_WARNINGmessage and_emit_charmlibs_deprecation_warning()helper instore.py. - Emits the warning at the start of
create-lib,publish-lib,fetch-lib,fetch-libs, andlist-lib. - Updates unit and integration tests to assert the warning is emitted.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| charmcraft/application/commands/store.py | Adds a shared deprecation warning constant/helper and emits it in all charmlibs-related commands. |
| tests/unit/commands/test_store.py | Adds/updates unit tests to assert the deprecation warning is emitted by relevant commands. |
| tests/integration/commands/test_store_commands.py | Updates fetch-lib integration test to assert the deprecation warning is emitted. |
Contributor
|
Thanks! @james-garner-canonical will create page that we should point to. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Alex Lowe <alex.lowe@canonical.com>
Contributor
|
Type checking with Command output |
mr-cal
reviewed
May 21, 2026
lengau
commented
May 21, 2026
Signed-off-by: Alex Lowe <alex.lowe@canonical.com>
Co-authored-by: James Garner <james.garner@canonical.com> Signed-off-by: Alex Lowe <alex.lowe@canonical.com>
james-garner-canonical
added a commit
to canonical/charmlibs
that referenced
this pull request
May 26, 2026
This PR adds a docs page about the upcoming deprecation of the Charmhub-hosted library machinery. This page will be pointed to from all `charmcraft` library operations in an upcoming Charmcraft release (canonical/charmcraft#2691). Due to the upcoming docs migration, I suggest we stick with the `ubu.link` approach suggested by Alex. So Charmcraft will show `https://ubu.link/charmhub-libraries-deprecation`, linking to `https://documentation.ubuntu.com/charmlibs/explanation/charmhub-libraries-deprecation/`. When we migrate the docs, we can delete the `ubu.link` and recreate it pointing to the new location. --------- Co-authored-by: Dave Wilding <tech@dpw.me>
james-garner-canonical
approved these changes
May 26, 2026
james-garner-canonical
left a comment
james-garner-canonical
left a comment
Contributor
There was a problem hiding this comment.
The docs page is now live, pointed to by https://ubu.link/charmhub-libraries-deprecation
I believe this PR should now be good to merge and include in the next Charmcraft release 😀
Thanks @lengau!
bepri
approved these changes
May 26, 2026
Co-authored-by: Imani Pelton <imani.pelton@canonical.com> Signed-off-by: Alex Lowe <alex.lowe@canonical.com>
mr-cal
approved these changes
Jun 17, 2026
mr-cal
left a comment
mr-cal
left a comment
Contributor
There was a problem hiding this comment.
Test/linter failures notwithstanding, the changes look good.
| ) | ||
| FetchLibCommand(config).run(args) | ||
|
|
||
| emitter.assert_progress(CHARMLIBS_DEPRECATION_WARNING, permanent=True) |
Contributor
There was a problem hiding this comment.
I think these need to be assert_warning?
MichaelThamm
pushed a commit
to canonical/charmlibs
that referenced
this pull request
Jun 26, 2026
This PR adds a docs page about the upcoming deprecation of the Charmhub-hosted library machinery. This page will be pointed to from all `charmcraft` library operations in an upcoming Charmcraft release (canonical/charmcraft#2691). Due to the upcoming docs migration, I suggest we stick with the `ubu.link` approach suggested by Alex. So Charmcraft will show `https://ubu.link/charmhub-libraries-deprecation`, linking to `https://documentation.ubuntu.com/charmlibs/explanation/charmhub-libraries-deprecation/`. When we migrate the docs, we can delete the `ubu.link` and recreate it pointing to the new location. --------- Co-authored-by: Dave Wilding <tech@dpw.me>
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Warns about the deprecation of charmhub-hosted charmlibs in all charmlibs-related commands.
make lint && make test.