fbehrendt/AutoPyDoc Action

Runs AutoPyDoc to generate Python docstrings and create a Pull Request.

Trust Signals

name	description	required	default
repo_path	Repo path (passed to --repo-path). Defaults to the workspace of the calling workflow.	no	${{ github.workspace }}
username	Username for PR attribution (passed to --username). Required by the script.	yes	—
pull_request_token	GitHub token (PAT or GITHUB_TOKEN) for creating pull requests (passed to --pull-request-token or via GITHUB_TOKEN env var). Required by the script.	yes	—
branch	Target branch in the repository (passed to --branch).	no	${{ github.ref_name }}
repo_owner	Owner of the target repository (passed to --repo-owner). Defaults to the current repository owner. If not set, script defaults to username.	no	${{ github.repository_owner }}
debug	Enable debug logging (passed as --debug flag).	no	false
context_size	Context size for the LLM model (passed to --context-size).	no	8192
strategy	The LLM strategy to use. Determines which subcommand is called. Options: ollama, gemini, local_deepseek, mock. [required]	yes	—
ollama_host	Full URL to Ollama host (e.g., http://localhost:11434). Passed to --ollama-host. Required if strategy is 'ollama'.	no	—
gemini_api_key	Google Gemini API Key. Passed to --gemini-api-key. Required if strategy is 'gemini'.	no	—
local_deepseek_device	Device for local_deepseek (GPT4All) model (e.g., 'gpu', 'cpu'). Passed to --device for local_deepseek strategy.	no	—

no outputs