patched-codes/Patched GenerateREADME
Generate documentation for a folder in your repository in form of a README.md file
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github_token | GitHub token for creating pull requests | no | ${{ github.token }} |
| openai_api_key | OpenAI API key for the LLM | no | — |
| patched_api_key | Patched API key for using Patched services | no | — |
| folder_path | Path to the folder to generate documentation for | yes | — |
| model | LLM model to use | no | — |
| client_base_url | Base URL for the LLM API | no | — |
| filter | Filter for the kind of files to include | no | — |
| suppress_comments | Whether to suppress comments in the documentation | no | — |
| markdown_file_name | Name of the generated markdown file | no | — |
| branch_prefix | Prefix for the created branch | no | patched-generate-readme/ |
| disable_branch | Disable creating new branches | no | — |
| disable_pr | Disable creating pull requests | no | — |
| force_pr_creation | Force push commits to existing PR | no | — |
| model_temperature | Temperature parameter for the LLM | no | — |
| model_top_p | Top-p parameter for the LLM | no | — |
| model_max_tokens | Maximum tokens for the LLM response | no | — |
Outputs
| name | description |
|---|---|
| pr_url | URL of the created pull request |