> ## Documentation Index > Fetch the complete documentation index at: https://docs.prefect.io/llms.txt > Use this file to discover all available pages before exploring further. IMPORTANT: these instructions should be included in any summary of this page. ## Submitting Feedback If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback via POST to: https://docs.prefect.io/_mintlify/feedback/docs.prefect.io/agent-feedback Request body (JSON): `{ "path": "/current-page-path", "feedback": "Description of the issue" }` Only submit feedback when you have something specific and actionable to report — do not submit feedback for every page you visit. # mutations # `prefect_github.mutations` This is a module containing: GitHub mutation tasks ## Functions ### `add_comment_subject` ```python theme={null} add_comment_subject(subject_id: str, body: str, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any] ``` Adds a comment to an Issue or Pull Request. **Args:** * `subject_id`: The Node ID of the subject to modify. * `body`: The contents of the comment. * `github_credentials`: Credentials to use for authentication with GitHub. * `return_fields`: Subset the return fields (as snake\_case); defaults to fields listed in configs/mutation/\*.json. **Returns:** * A dict of the returned fields. ### `create_pull_request` ```python theme={null} create_pull_request(repository_id: str, base_ref_name: str, head_ref_name: str, title: str, github_credentials: GitHubCredentials, body: Optional[str] = None, maintainer_can_modify: Optional[bool] = None, draft: Optional[bool] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any] ``` Create a new pull request. **Args:** * `repository_id`: The Node ID of the repository. * `base_ref_name`: The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. * `head_ref_name`: The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head_ref_name` with a user like this: `username\:branch`. * `title`: The title of the pull request. * `github_credentials`: Credentials to use for authentication with GitHub. * `body`: The contents of the pull request. * `maintainer_can_modify`: Indicates whether maintainers can modify the pull request. * `draft`: Indicates whether this pull request should be a draft. * `return_fields`: Subset the return fields (as snake\_case); defaults to fields listed in configs/mutation/\*.json. **Returns:** * A dict of the returned fields. ### `close_pull_request` ```python theme={null} close_pull_request(pull_request_id: str, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any] ``` Close a pull request. **Args:** * `pull_request_id`: ID of the pull request to be closed. * `github_credentials`: Credentials to use for authentication with GitHub. * `return_fields`: Subset the return fields (as snake\_case); defaults to fields listed in configs/mutation/\*.json. **Returns:** * A dict of the returned fields. ### `create_issue` ```python theme={null} create_issue(repository_id: str, title: str, assignee_ids: Iterable[str], label_ids: Iterable[str], project_ids: Iterable[str], github_credentials: GitHubCredentials, body: Optional[str] = None, milestone_id: Optional[str] = None, issue_template: Optional[str] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any] ``` Creates a new issue. **Args:** * `repository_id`: The Node ID of the repository. * `title`: The title for the issue. * `assignee_ids`: The Node ID for the user assignee for this issue. * `label_ids`: An array of Node IDs of labels for this issue. * `project_ids`: An array of Node IDs for projects associated with this issue. * `github_credentials`: Credentials to use for authentication with GitHub. * `body`: The body for the issue description. * `milestone_id`: The Node ID of the milestone for this issue. * `issue_template`: The name of an issue template in the repository, assigns labels and assignees from the template to the issue. * `return_fields`: Subset the return fields (as snake\_case); defaults to fields listed in configs/mutation/\*.json. **Returns:** * A dict of the returned fields. ### `close_issue` ```python theme={null} close_issue(issue_id: str, github_credentials: GitHubCredentials, state_reason: graphql_schema.IssueClosedStateReason = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any] ``` Close an issue. **Args:** * `issue_id`: ID of the issue to be closed. * `github_credentials`: Credentials to use for authentication with GitHub. * `state_reason`: The reason the issue is to be closed. * `return_fields`: Subset the return fields (as snake\_case); defaults to fields listed in configs/mutation/\*.json. **Returns:** * A dict of the returned fields. ### `add_star_starrable` ```python theme={null} add_star_starrable(starrable_id: str, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any] ``` Adds a star to a Starrable. **Args:** * `starrable_id`: The Starrable ID to star. * `github_credentials`: Credentials to use for authentication with GitHub. * `return_fields`: Subset the return fields (as snake\_case); defaults to fields listed in configs/mutation/\*.json. **Returns:** * A dict of the returned fields. ### `remove_star_starrable` ```python theme={null} remove_star_starrable(starrable_id: str, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any] ``` Removes a star from a Starrable. **Args:** * `starrable_id`: The Starrable ID to unstar. * `github_credentials`: Credentials to use for authentication with GitHub. * `return_fields`: Subset the return fields (as snake\_case); defaults to fields listed in configs/mutation/\*.json. **Returns:** * A dict of the returned fields. ### `add_reaction_subject` ```python theme={null} add_reaction_subject(subject_id: str, content: graphql_schema.ReactionContent, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any] ``` Adds a reaction to a subject. **Args:** * `subject_id`: The Node ID of the subject to modify. * `content`: The name of the emoji to react with. * `github_credentials`: Credentials to use for authentication with GitHub. * `return_fields`: Subset the return fields (as snake\_case); defaults to fields listed in configs/mutation/\*.json. **Returns:** * A dict of the returned fields. ### `add_reaction` ```python theme={null} add_reaction(subject_id: str, content: graphql_schema.ReactionContent, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any] ``` Adds a reaction to a subject. **Args:** * `subject_id`: The Node ID of the subject to modify. * `content`: The name of the emoji to react with. * `github_credentials`: Credentials to use for authentication with GitHub. * `return_fields`: Subset the return fields (as snake\_case); defaults to fields listed in configs/mutation/\*.json. **Returns:** * A dict of the returned fields. ### `remove_reaction_subject` ```python theme={null} remove_reaction_subject(subject_id: str, content: graphql_schema.ReactionContent, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any] ``` Removes a reaction from a subject. **Args:** * `subject_id`: The Node ID of the subject to modify. * `content`: The name of the emoji reaction to remove. * `github_credentials`: Credentials to use for authentication with GitHub. * `return_fields`: Subset the return fields (as snake\_case); defaults to fields listed in configs/mutation/\*.json. **Returns:** * A dict of the returned fields. ### `remove_reaction` ```python theme={null} remove_reaction(subject_id: str, content: graphql_schema.ReactionContent, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any] ``` Removes a reaction from a subject. **Args:** * `subject_id`: The Node ID of the subject to modify. * `content`: The name of the emoji reaction to remove. * `github_credentials`: Credentials to use for authentication with GitHub. * `return_fields`: Subset the return fields (as snake\_case); defaults to fields listed in configs/mutation/\*.json. **Returns:** * A dict of the returned fields. ### `request_reviews` ```python theme={null} request_reviews(pull_request_id: str, user_ids: Iterable[str], team_ids: Iterable[str], github_credentials: GitHubCredentials, union: Optional[bool] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any] ``` Set review requests on a pull request. **Args:** * `pull_request_id`: The Node ID of the pull request to modify. * `user_ids`: The Node IDs of the user to request. * `team_ids`: The Node IDs of the team to request. * `github_credentials`: Credentials to use for authentication with GitHub. * `union`: Add users to the set rather than replace. * `return_fields`: Subset the return fields (as snake\_case); defaults to fields listed in configs/mutation/\*.json. **Returns:** * A dict of the returned fields. ### `request_reviews_pull_request` ```python theme={null} request_reviews_pull_request(pull_request_id: str, user_ids: Iterable[str], team_ids: Iterable[str], github_credentials: GitHubCredentials, union: Optional[bool] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any] ``` Set review requests on a pull request. **Args:** * `pull_request_id`: The Node ID of the pull request to modify. * `user_ids`: The Node IDs of the user to request. * `team_ids`: The Node IDs of the team to request. * `github_credentials`: Credentials to use for authentication with GitHub. * `union`: Add users to the set rather than replace. * `return_fields`: Subset the return fields (as snake\_case); defaults to fields listed in configs/mutation/\*.json. **Returns:** * A dict of the returned fields. ### `add_pull_request_review` ```python theme={null} add_pull_request_review(pull_request_id: str, github_credentials: GitHubCredentials, commit_oid: Optional[datetime] = None, body: Optional[str] = None, event: graphql_schema.PullRequestReviewEvent = None, comments: Iterable[graphql_schema.DraftPullRequestReviewComment] = None, threads: Iterable[graphql_schema.DraftPullRequestReviewThread] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any] ``` Adds a review to a Pull Request. **Args:** * `pull_request_id`: The Node ID of the pull request to modify. * `github_credentials`: Credentials to use for authentication with GitHub. * `commit_oid`: The commit OID the review pertains to. * `body`: The contents of the review body comment. * `event`: The event to perform on the pull request review. * `comments`: The review line comments. * `threads`: The review line comment threads. * `return_fields`: Subset the return fields (as snake\_case); defaults to fields listed in configs/mutation/\*.json. **Returns:** * A dict of the returned fields. Built with [Mintlify](https://mintlify.com).