docs: generate jaas cli reference#1792
Merged
kian99 merged 4 commits intocanonical:v3from Jan 7, 2026
Merged
Conversation
tmihoc
approved these changes
Jan 7, 2026
Member
tmihoc
left a comment
There was a problem hiding this comment.
LGTM, and thanks for fixing the .readthedocs.yaml issue too!
luci1900
reviewed
Jan 7, 2026
| //go:generate mockgen -typed -destination=./mocks/jujucommands.go -package=mocks . JujuCommands | ||
| //go:generate mockgen -typed -destination=./mocks/jujuclientstore.go -package=mocks github.com/juju/juju/jujuclient ClientStore | ||
| //go:generate mockgen -typed -destination=./mocks/credentialstore.go -package=mocks . CredentialStore | ||
| //go:generate go tool mockgen -typed -destination=./mocks/store.go -package=mocks . Store |
Contributor
There was a problem hiding this comment.
I hadn't realised tools.go was now obsolete, nice.
luci1900
approved these changes
Jan 7, 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 join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
This PR removes the
publish-docs.yamlworkflow that would publish a PR to the docs repo for thejaasCLI, in favor of a script that updates the docs locally.Additionally we add a job to our
ci.yamlworkflow to verify that runningmake generateresults in no diff.Finally, the generated CLI reference doc has been changed from a
.rstfile to markdown to match our other doc files. The one downside is that the markdown generated documentation makes each command start with a h1 heading or# <heading>so there is no discernible way (at least to me) to add a separate heading to the doc. Trying to add a separate heading causes some issues with the contents bar that read-the-docs generates on the right hand side of the page.Edit: I've also updated places where we were generating mocks with
mockgen ...togo tool mockgen .... The latter was already used in some places but not others. It should make it simpler to rungo generate ./...in CI.Fixes JUJU-8983