0xrobinr/documeth

Generates documentation and an append-only history entry from git diffs, then opens a PR.

Trust Signals

workflow.ymlSHA-pinned

uses: 0xrobinr/documeth@1547be2f235f9f84b1cbd66ac6458b1e340d8cf0 # no releases — HEAD as of 2026-07-16

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

name	description	required	default
openai_api_key	OpenAI API key	yes	—
model	OpenAI model name (Responses API)	no	gpt-4o
mode	diff (default) or full	no	diff
include_globs	Newline-separated glob patterns to include	no	src/*/.ts src/*/.tsx packages/*/.ts packages/*/.tsx
exclude_globs	Newline-separated glob patterns to exclude	no	*/.test.ts */.spec.ts /node_modules/ /dist/ /build/ /.next/ /coverage/ */.min.* */.map */.d.ts
max_files	Max changed files to send to the model	no	25
max_chars_per_file	Max characters per file to send	no	12000
docs_dir	Docs directory to write into	no	docs
history_file	Append-only history file (relative path)	no	docs/HISTORY.md
pr_branch	Branch name for docs PR	no	bot/documeth
pr_title	Pull request title	no	docs: documeth update
pr_body	Pull request body	no	This PR was generated automatically. - Updates documentation based on recent code changes - Appends an entry to docs history
commit_message	Commit message	no	docs: update documentation (documeth)
add_paths	Paths to include in PR commit (git pathspec), newline-separated	no	docs/**

no outputs