pelikhan/action-continuous-comments

Generates and updates code comments using an AST/LLM hybrid approach. It uses ast-grep to look for undocumented and documented functions, classes, interfaces, and other entities in the codebase, then uses a combination of LLM, and LLM-as-a-judge to generate and validate the documentation. You should pretify your code before and after running this script to normalize the formatting.

View on GitHub

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stale
License: None

Inputs

name	description	required	default
model	The LLM model to use for generation.	no	—
instructions	Additional prompting instructions for the LLM.	no	—
dry_run	If true, the script will not modify files.	no	false
mock	If true, the script will mock LLM results.	no	false
judge	If true, the script will judge the generated docs.	no	false
update_existing	Update existing docs.	no	false
max_edits	Maximum number of new or updated comments total.	no	50
kinds	The kinds of entities to target for documentation generation. This is a comma-separated list of entity types, e.g. "module,type,function,property,variable". If not specified, all entities will be targeted. Valid values: module,type,function,property,variable	no	module,type,function,property
exports_only	If true, only generate docs for exported entities.	no	false
max_context	Maximum number of tokens to build content of requests.	no	6000
files	Files to process, separated by semi columns (;). .ts,.mts,.tsx,.mtsx,.cts,.py,.cs,.java,.h,.c,.rs,.cpp,.hpp,.cc,.cxx,.go	no	—
debug	Enable debug logging (https://microsoft.github.io/genaiscript/reference/scripts/logging/).	no	—
model_alias	A YAML-like list of model aliases and model id: `translation: github:openai/gpt-4o`	no	—
openai_api_key	OpenAI API key	no	—
openai_api_base	OpenAI API base URL	no	—
azure_openai_api_endpoint	Azure OpenAI endpoint. In the Azure Portal, open your Azure OpenAI resource, Keys and Endpoints, copy Endpoint.	no	—
azure_openai_api_key	Azure OpenAI API key. **You do NOT need this if you are using Microsoft Entra ID.	no	—
azure_openai_subscription_id	Azure OpenAI subscription ID to list available deployments (Microsoft Entra only).	no	—
azure_openai_api_version	Azure OpenAI API version.	no	—
azure_openai_api_credentials	Azure OpenAI API credentials type. Leave as 'default' unless you have a special Azure setup.	no	—
azure_ai_inference_api_key	Azure AI Inference key	no	—
azure_ai_inference_api_endpoint	Azure Serverless OpenAI endpoint	no	—
azure_ai_inference_api_version	Azure Serverless OpenAI API version	no	—
azure_ai_inference_api_credentials	Azure Serverless OpenAI API credentials type	no	—
github_token	GitHub token with `models: read` permission at least (https://microsoft.github.io/genaiscript/reference/github-actions/#github-models-permissions).	no	—

Outputs

name	description
text	The generated text output.