Add Comment To Issue
add_comment_to_issueFull Description
Create a top-level PR Conversation comment (Issue comment).
Parameters (3 required)
commentstringpr_numberintegerrepo_full_namestringExplore repository files, documentation, folder structures, and commit history to understand code, prepare reviews, or document a project. Summarize pull requests, clarify how parts of the codebase fit together, or turn technical details into approachable explanations when sharing work with others.
add_comment_to_issueCreate a top-level PR Conversation comment (Issue comment).
commentstringpr_numberintegerrepo_full_namestringadd_reaction_to_issue_commentAdd a reaction to an issue comment.
comment_idintegerreactionstringrepo_full_namestringadd_reaction_to_prAdd a reaction to a GitHub pull request.
pr_numberintegerreactionstringrepo_full_namestringadd_reaction_to_pr_review_commentAdd a reaction to a pull request review comment.
comment_idintegerreactionstringrepo_full_namestringadd_review_to_prAdd a review to a GitHub pull request. review is required for REQUEST_CHANGES and COMMENT events.
actionfile_commentsarraypr_numberintegerrepo_full_namestringreviewstringcommit_idstringnullcheck_repo_initializedCheck if a GitHub repository has been set up.
repo_idintegercompare_commitsCompare two commits/refs and return per-file stats plus compare metadata.
This is a thin wrapper around GithubPlugin.compare_commits to provide a stable, compact response shape to connector consumers.
basestringheadstringrepo_full_namestringcreate_blobCreate a blob in the repository and return its SHA.
contentstringrepository_full_namestringencodingstringOne of utf-8 or base64. Default is utf-8.
utf-8base64utf-8create_branchCreate a new branch in the given repository from base_branch.
branch_namestringrepository_full_namestringshastringcreate_commitCreate a commit pointing to tree_sha with parent parent_sha.
messagestringparent_shastringrepository_full_namestringtree_shastringcreate_fileCreate a new file in the repository via the contents API.
contentstringmessagestringpathstringrepository_full_namestringbranchstringnullcreate_pull_requestOpen a pull request in the repository.
base_branchstringbodystringhead_branchstringrepository_full_namestringtitlestringdraftbooleanFalsecreate_treeCreate a tree object in the repository from the given elements.
repository_full_namestringtree_elementsarraybase_tree_shastringnulldownload_user_contenturlstringenable_auto_mergeEnable auto-merge for a pull request.
pr_numberintegerrepository_full_namestringfetchFetch a file from GitHub by URL.
urlstringfetch_blobFetch blob content by SHA from the given repository.
blob_shastringrepository_full_namestringfetch_commitcommit_shastringrepo_full_namestringfetch_fileFetch file content by path and ref from the given repository.
pathstringrefstringrepository_full_namestringencodingstringOne of utf-8 or base64. Default is utf-8.
utf-8base64utf-8fetch_issueFetch GitHub issue.
issue_numberintegerrepostringfetch_issue_commentsFetch comments for a GitHub issue.
issue_numberintegerrepo_full_namestringfetch_prpr_numberintegerrepo_full_namestringfetch_pr_commentsFetch comments for a GitHub pull request.
pr_numberintegerrepo_full_namestringfetch_pr_file_patchpathstringpr_numberintegerrepo_full_namestringfetch_pr_patchFetch the patch for a GitHub pull request.
pr_numberintegerrepo_full_namestringget_commit_combined_statuscommit_shastringrepo_full_namestringget_issue_comment_reactionsFetch reactions for an issue comment.
comment_idintegerrepo_full_namestringpageintegernullper_pageintegernullget_pr_diffpr_numberintegerrepo_full_namestringformatstringdiffpatchdiffget_pr_infoGet metadata (title, description, refs, and status) for a pull request.
This action does *not* include the actual code changes. If you need the diff or per-file patches, call fetch_pr_patch instead (or use get_users_recent_prs_in_repo with `include_diff=True` when listing the user's own PRs).
pr_numberintegerrepository_full_namestringget_pr_reactionsFetch reactions for a GitHub pull request.
pr_numberintegerrepo_full_namestringpageintegernullper_pageintegernullget_pr_review_comment_reactionsFetch reactions for a pull request review comment.
comment_idintegerrepo_full_namestringpageintegernullper_pageintegernullget_profileRetrieve the GitHub profile for the authenticated user.
get_repoRetrieve metadata for a GitHub repository.
repo_idstringget_repo_collaborator_permissionrepository_full_namestringusernamestringget_user_loginReturn the GitHub login for the authenticated user.
get_users_recent_prs_in_repoList the user's recent GitHub pull requests in a repository.
repository_full_namestringinclude_commentsbooleanFalseinclude_diffbooleanFalselimitinteger20statestringalllabel_prLabel a pull request.
labelstringpr_numberintegerrepository_full_namestringlist_installationsList all organizations the authenticated user has installed this GitHub App on.
list_installed_accountsList all accounts that the user has installed our GitHub app on.
list_pr_changed_filenamespr_numberintegerrepo_full_namestringlist_recent_issuesReturn the most recent GitHub issues the user can access.
top_kinteger20list_repositoriesList repositories accessible to the authenticated user.
include_search_index_statusbooleanFalsepage_offsetinteger0page_sizeinteger20list_repositories_by_affiliationList repositories accessible to the authenticated user filtered by affiliation.
affiliationstringpage_offsetinteger0page_sizeinteger100list_repositories_by_installationList repositories accessible to the authenticated user.
installation_idintegerpage_offsetinteger0page_sizeinteger20list_user_org_membershipslist_user_orgsList organizations the authenticated user is a member of.
remove_reaction_from_issue_commentRemove a reaction from an issue comment.
comment_idintegerreaction_idintegerrepo_full_namestringremove_reaction_from_prRemove a reaction from a GitHub pull request.
pr_numberintegerreaction_idintegerrepo_full_namestringremove_reaction_from_pr_review_commentRemove a reaction from a pull request review comment.
comment_idintegerreaction_idintegerrepo_full_namestringreply_to_review_commentReply to an inline review comment on a PR (Files changed thread). comment_id must be the ID of the thread’s top-level inline review comment (replies-to-replies are not supported by the API)
commentstringcomment_idintegerpr_numberintegerrepo_full_namestringsearchSearch files within a specific GitHub repository.
Provide a plain string query, avoid GitHub query flags such as `is:pr. Include keywords that match file names, functions, or error messages. repository_name or org can narrow the search scope. Example: query="tokenizer bug" repository_name="tiktoken". topn` is the number of results to return. No results are returned if the query is empty.
querystringorgstringnullrepository_namestringnulltopninteger20search_branchesSearch GitHub branches within a repository.
ownerstringquerystringrepo_namestringcursorstringnullpage_sizeinteger20search_commitsquerystringordernullorgstringnullrepostringnullsortnulltopninteger20search_installed_repositories_streamingSearch for a repository (not a file) by name or description. To search for a file, use search.
querystringlimitinteger10next_tokenstringnulloption_enrich_code_search_index_availabilitybooleanTrueoption_enrich_code_search_index_request_concurrency_limitinteger10search_installed_repositories_v2Search repositories within the user's installations using GitHub search.
querystringinclude_search_index_statusbooleanFalseinstallation_idsarraynulllimitinteger10pageinteger1search_issuesSearch GitHub issues.
querystringrepostringordernullsortnulltopninteger20search_prsSearch GitHub pull requests.
querystringordernullorgstringnullrepostringnullsortnulltopninteger20search_repositoriesSearch for a repository (not a file) by name or description. To search for a file, use search.
querystringorgstringnullpageinteger1per_pageintegernulltopnintegernullupdate_issue_commentUpdate a top-level PR Conversation comment (Issue comment).
commentstringcomment_idintegerrepo_full_namestringupdate_refMove branch ref to the given commit SHA.
branch_namestringrepository_full_namestringshastringforcebooleanFalseupdate_review_commentUpdate an inline review comment (or a reply) on a PR.
commentstringcomment_idintegerrepo_full_namestring