actions-marketplace-validations/Upload Charm Docs

Upload charm documentation to charmhub

Trust Signals

workflow.ymlSHA-pinned

uses: actions-marketplace-validations/canonical_upload-charm-docs@62c3badfb125421a81aa40480eb6321298f62167 # no releases — HEAD as of 2026-07-10

tags can be moved; commit SHAs can't. why a SHA?

name	description	required	default
dry_run	If enabled, only log the changes that would be made.	no	false
delete_topics	Whether to delete topics from the documentation server if they are no longer needed.	no	true
discourse_host	The base path(hostname) to the discourse server.	yes	—
discourse_api_username	The discourse API username to use for interactions with the server.	yes	—
discourse_api_key	The discourse API key to use for interactions with the server.	yes	—
discourse_category_id	The category identifier to use on discourse for all topics.	no	41
github_token	The github access token (secrets.GITHUB_TOKEN) to create pull request on Github and retrieve the current documentation.	yes	—
base_branch	The name of the base branch for the repository.	no	main
commit_sha	The SHA of the commit to be used when running the action. If not provided, it falls back to the pull request head SHA or (if outside of a PR) to the value of the environment variable GITHUB_SHA.	no	—
charm_dir	Relative name of the directory where the metadata.yaml or charmcraft.yaml files are located if they are not in the root directory of the repository. The docs directory is also located under this directory.	no	""

name	description
index_url	A JSON map with the urls and the actions that have been taken against them.
topics	A JSON map with the urls and the actions that have been taken against them.
pr_link	A link of the community contribution PR.
pr_action	A description of which actions for the PR has been taken among created, closed and updated.