Fix stale docs URL in CLI auth warning#1149
Open
mvanhorn wants to merge 1 commit into
Open
Conversation
Signed-off-by: Matt Van Horn <455140+mvanhorn@users.noreply.github.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1149 +/- ##
=======================================
Coverage 78.01% 78.01%
=======================================
Files 118 118
Lines 12412 12412
Branches 1023 1023
=======================================
Hits 9683 9683
Misses 2508 2508
Partials 221 221
*This pull request uses carry forward flags. Click here to find out more.
🚀 New features to boost your workflow:
|
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
1 participant
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.
Description
When the CLI returns a 401 because a feature requiring client authorisation was used without client credentials, it prints a help link pointing at
https://testflinger.readthedocs.io/..., which is no longer the live docs host. This updates the warning tohttps://canonical-testflinger.readthedocs-hosted.com/en/latest/how-to/authentication/, matching the host already used elsewhere in the repo (server/agent charms and thesubmitGitHub action). The path is unchanged; only the stale host is corrected.Resolved issues
Fixes #961
Documentation
No documentation changes. This points an existing user-facing message at the live docs page rather than the stale one.
Web service API changes
None.
Tests
grep -rn "testflinger.readthedocs.io" cli/testflinger_cli/returns no matches after the change, and the concatenated URL resolves to the livecanonical-testflinger.readthedocs-hosted.comauthentication page. The string is not asserted by the existing CLI suite, so no test changes are needed.