jasonjgardner/AI JSDoc Generator

Automatically generate and suggest JSDoc comments for your JavaScript and TypeScript code in pull requests

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Maintainedlast commit May 7, 2025
License
Apache 2.0

Pinned Snippet

workflow.ymlSHA-pinned
uses: jasonjgardner/action-ai-jsdoc@c1e1881af43b579632f29b46868f84400d94fdff # no releases — HEAD as of 2026-07-11

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

namedescriptionrequireddefault
github-tokenGitHub token with permission to create PR comments and reviewsyes${{ github.token }}
openai-api-keyYour OpenAI API keyyes
openai-modelOpenAI model to use for generating JSDoc commentsnogpt-3.5-turbo
include-filesGlob pattern for files to process (e.g., "**/*.js,**/*.ts")no**/*.{js,jsx,ts,tsx}
exclude-filesGlob pattern for files to exclude (e.g., "node_modules/**,dist/**")nonode_modules/**,dist/**,build/**,coverage/**
review-modeHow to submit suggestions: "suggestion" (PR review comments) or "commit" (direct commits)nosuggestion
temperatureTemperature value for OpenAI API (0.0 to 1.0)no0.2

no outputs