GitHub is a code hosting platform for version control and collaboration, offering Git-based repository management, issue tracking, and continuous integration features
GitHub is a code hosting platform for version control and collaboration, offering Git-based repository management, issue tracking, and continuous integration features On Nagent, GitHub is exposed as a fully-configurable developer tools integration that any agent can call — 867 actions, 46 triggers, and OAuth authentication. No code is required to wire GitHub into your workflow — connect it once via the External Integrations panel and reuse it across every agent you build.
Agent builders use GitHub to automate the kinds of tasks developer tools teams previously handled manually. Concrete examples — each one is a single agent step in Nagent — include:
GitHub also supports 4 event triggers ("New Workflow Artifact Created", "Branch Changed", "New Branch Created", and more), which lets your Nagent agents react to GitHub activity in real time — for example, kicking off a downstream workflow the moment a relevant event fires.
Every action and trigger is paired with a structured input/output schema (visible in the sections below), so when you wire GitHub into Helix — our agentic agent builder — the editor knows exactly what each step expects and produces. Configure once, deploy anywhere across your Nagent agents.
Triggers are the entry points of agents built on Nagent — pick one to fire your agent the moment a GitHub event happens. Webhook triggers run instantly; poll triggers check on an interval you configure. Each shows its configuration parameters and the payload your agent receives.
GITHUB_ARTIFACT_CREATED_TRIGGERTriggers when a new workflow artifact is created in a GitHub repository. Monitors for newly created GitHub Actions workflow artifacts. Optionally filters by artifact name to restrict monitoring to specific artifacts.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
Optional artifact name filter. When set, only artifacts whose name exactly matches this value will be reported. Leave blank to monitor all artifacts in the repository.
GitHub username or organisation that owns the repository (e.g. 'octocat' or 'microsoft').
Repository name without the .git extension (e.g. 'Hello-World' or 'my-project').
Payload
URL to download the artifact as a zip archive.
Unique numeric identifier of the newly created artifact.
ISO 8601 timestamp of when the artifact was created.
SHA-256 digest of the artifact (only present for artifacts uploaded with upload-artifact v4 or later).
Type of event that occurred.
Whether the artifact has expired and is no longer available.
ISO 8601 timestamp of when the artifact will expire.
Name of the artifact.
GraphQL node ID of the artifact.
Owner of the repository.
Repository name.
Size of the artifact in bytes.
ISO 8601 timestamp of when the artifact was last updated.
API URL for the artifact.
Metadata about the workflow run that produced the artifact.
GITHUB_BRANCH_CHANGED_TRIGGERTriggers when a GitHub branch changes. Monitors a specific branch for: - New commits pushed (head commit SHA changes) - Protection status toggled (branch becomes protected or unprotected) - Protection settings changed, including: required status checks and their enforcement level, admin enforcement, required pull request reviews (dismiss stale reviews, code owner reviews, approving review count, last push approval), required linear history, force push allowance, deletion allowance, conversation resolution, branch locking, and fork syncing.
Configuration
The exact name of the branch to monitor (e.g. 'main' or 'develop'). The name is case-sensitive and must match exactly what is shown in the repository.
Periodic Interval to Check for Updates & Send a Trigger in Minutes
GitHub username or organisation that owns the repository (e.g. 'octocat' or 'microsoft').
Repository name without the .git extension (e.g. 'Hello-World' or 'my-service').
Payload
Name of the monitored branch.
Names of the top-level fields that changed.
Snapshot of the branch's tracked fields after the change.
Type of event that occurred.
The current head commit SHA of the branch.
Owner of the repository.
Snapshot of the branch's tracked fields before the change.
Whether the branch is currently protected.
Repository name.
GITHUB_BRANCH_CREATED_TRIGGERTriggers when a new branch is created in a GitHub repository. Detects newly created branches. Deleted branches do not fire events.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
The account owner of the repository (GitHub username or organization name). Must contain only alphanumeric characters and hyphens, max 39 characters.
The name of the repository without the .git extension. Must contain only alphanumeric characters, hyphens, underscores, and periods.
Payload
SHA of the HEAD commit on the new branch.
GitHub REST API URL for the HEAD commit on the new branch.
The name of the newly created branch.
Whether the branch has branch-protection rules enabled.
Name of the repository the branch belongs to.
GitHub username or organization that owns the repository.
GITHUB_CHECK_RUN_STATUS_CHANGED_TRIGGERTriggers when a specific GitHub check run changes its status or conclusion. Monitors a single check run for changes to: status (queued, in_progress, completed, etc.), conclusion (success, failure, neutral, cancelled, skipped, timed_out, action_required), started_at, and completed_at.
Configuration
The unique numeric identifier of the check run to monitor. You can obtain it from the check runs list API or from the CI/checks page in the GitHub UI.
Periodic Interval to Check for Updates & Send a Trigger in Minutes
The account owner of the repository (username or organization name). Case-insensitive. Must contain only alphanumeric characters and hyphens.
The name of the repository without the .git extension. Case-insensitive.
Payload
GitHub App that created the check run.
List of field names that changed since the last poll.
The ID of the check suite this check run belongs to.
ISO 8601 timestamp when the check run completed.
The conclusion of a completed check run: success, failure, neutral, cancelled, skipped, timed_out, or action_required.
URL providing detailed information about the check run.
The external identifier for the check run set by the integrator.
The SHA of the commit this check run targets.
The GitHub URL to view this check run.
The unique numeric ID of the check run.
The name of the check run.
The GraphQL node ID of the check run.
Output details for a GitHub check run.
Previous string-serialized values of the changed fields.
The name of the repository the check run belongs to.
The owner of the repository the check run belongs to.
ISO 8601 timestamp when the check run started.
The current status of the check run: queued, in_progress, completed, waiting, requested, or pending.
The REST API URL for this check run.
GITHUB_CHECK_SUITE_STATUS_CHANGED_TRIGGERTriggers when a GitHub check suite changes its status or conclusion for a given ref. Monitors all check suites associated with a git reference (branch, tag, or commit SHA) for changes to status (queued, in_progress, completed, etc.) and conclusion (success, failure, neutral, cancelled, skipped, timed_out, action_required, startup_failure, stale). Optionally filters by GitHub App ID.
Configuration
Optional: Filters check suites by GitHub App ID. Only monitor check suites created by this specific app. If omitted, all check suites for the ref are monitored.
Periodic Interval to Check for Updates & Send a Trigger in Minutes
The account owner of the repository (username or organization name). Case-insensitive. Must contain only alphanumeric characters and hyphens.
The git reference (branch name, tag name, or commit SHA) to monitor check suites for. For example, 'main', 'v1.0.0', or a full commit SHA.
The name of the repository without the .git extension. Case-insensitive.
Payload
GitHub App associated with a check suite.
List of field names that changed since the last poll.
The API URL to retrieve the check runs in this suite.
The overall conclusion of the completed check suite: success, failure, neutral, cancelled, skipped, timed_out, action_required, startup_failure, or stale. Null if not yet completed.
ISO 8601 timestamp when this check suite was created.
The branch name the check suite belongs to.
The SHA of the head commit being checked.
The unique numeric ID of the check suite.
The number of check runs in this check suite.
The GraphQL node ID of the check suite.
Previous string-serialized values of the changed fields.
The git reference (branch/tag/SHA) that was monitored.
The name of the repository this check suite belongs to.
The owner of the repository this check suite belongs to.
The current phase of the check suite lifecycle: queued, in_progress, completed, waiting, requested, or pending.
ISO 8601 timestamp when this check suite was last updated.
The REST API URL for this check suite.
GITHUB_CODE_SCANNING_ALERT_CREATED_TRIGGERTriggers when a new code scanning alert is created in a repository. Fires an event for each newly created code scanning alert detected in the configured repository. Alerts can be filtered by Git reference, scanning tool, state, and severity. The payload includes the alert number, rule details, tool information, state, severity, and the location of the most recent instance.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
The account owner of the repository (GitHub username or organization name). The name is not case sensitive.
Optional Git reference to filter alerts by. For a branch use 'refs/heads/<branch name>' or just the branch name. For a pull request use 'refs/pull/<number>/merge'. Leave empty to get alerts across all refs (default branch).
The name of the repository without the .git extension. The name is not case sensitive.
Optional filter by alert severity. Possible values: 'critical', 'high', 'medium', 'low', 'warning', 'note', 'error'. Leave empty to include alerts of all severities.
Optional filter by alert state. Possible values: 'open', 'closed', 'dismissed', 'fixed'. Leave empty to include alerts in all states.
Optional name of a code scanning tool to filter alerts by (e.g. 'CodeQL', 'Semgrep'). Leave empty to include alerts from all tools.
Payload
The unique sequential number identifying the alert within the repository.
The REST API URL of the alert resource.
ISO 8601 timestamp when the alert was created.
ISO 8601 timestamp when the alert was dismissed. Null if not dismissed.
Reason for dismissal: 'false positive', "won't fix", or 'used in tests'.
ISO 8601 timestamp when the alert was fixed. Null if not fixed.
The GitHub web URL of the alert.
REST API URL to retrieve all instances of this alert.
Commit SHA where the most recent instance was detected.
Description of the vulnerability from the most recent instance.
File path of the most recent instance location.
The Git ref where the most recent instance was detected.
Start line of the most recent instance location.
State of the most recent instance: 'open', 'dismissed', or 'fixed'.
The name of the repository.
The GitHub username or organization that owns the repository.
The rule that triggered the code scanning alert.
Current state of the alert: 'open', 'closed', 'dismissed', or 'fixed'.
The code scanning tool that generated the alert.
ISO 8601 timestamp when the alert was last updated.
GITHUB_COLLABORATOR_ADDED_TRIGGERTriggers when a new collaborator is added to a GitHub repository. Monitors the full list of collaborators on a repository and fires an event for each newly added collaborator. The payload includes the collaborator's GitHub username, account ID, profile URL, avatar URL, permission flags (pull, triage, push, maintain, admin), and assigned role name.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
The account owner of the repository (username or organization name). Must contain only alphanumeric characters and hyphens, max 39 characters.
The name of the repository without the .git extension. Must contain only alphanumeric characters, hyphens, underscores, and periods.
Payload
URL of the collaborator's avatar image.
GitHub profile URL of the collaborator.
The unique numeric ID of the collaborator's GitHub account.
The GitHub username of the new collaborator.
GraphQL global node identifier for the collaborator.
Permission flags granted to the collaborator on this repository.
The name of the repository.
The owner of the repository.
The role name assigned to the collaborator (e.g., 'admin', 'maintain', 'write', 'triage', 'read').
Whether the collaborator is a GitHub site administrator.
The type of GitHub account (e.g., 'User', 'Organization').
REST API URL for the collaborator's user resource.
GITHUB_COMMIT_EVENTTriggered when a new commit is pushed to a repository.
Configuration
Owner of the repository
Repository name
Payload
The GitHub username of the commit author
The SHA of the commit
The commit message
The timestamp of the commit
The GitHub URL of the commit
GITHUB_DEPLOYMENT_CREATED_TRIGGERTriggers when a new deployment is created in a GitHub repository. Fires an event for each newly created deployment detected in the configured repository. Deployments can optionally be filtered by target environment. The payload includes the deployment ID, commit SHA, ref, task, environment, creator details, and timestamps.
Configuration
Optional filter: only fire for deployments targeting this environment (e.g. 'production', 'staging', 'Preview'). Leave empty to receive events for all environments.
Periodic Interval to Check for Updates & Send a Trigger in Minutes
GitHub username or organisation that owns the repository (e.g. 'octocat' or 'microsoft').
Repository name without the .git extension (e.g. 'Hello-World' or 'vscode').
Payload
ISO 8601 timestamp when the deployment was created.
Numeric ID of the creator.
GitHub login of the user or bot that created the deployment.
Account type of the creator (e.g. 'User', 'Bot').
Unique numeric identifier for the deployment.
A short description of the deployment.
The name of the environment the deployment targets (e.g. 'production').
Type of event that occurred.
Global Node ID for the deployment.
The original environment of the deployment before any overrides.
Owner of the repository.
Whether this deployment targets the production environment.
The short ref name or full SHA of the deployment's target.
Repository name.
API URL for the repository the deployment belongs to.
The SHA of the commit that was deployed.
API URL to list deployment statuses.
The name of the task that was used for the deployment (e.g. 'deploy').
Whether this is a transient environment (destroyed on inactivity).
ISO 8601 timestamp when the deployment was last updated.
API URL for this deployment resource.
GITHUB_DEPLOYMENT_STATE_CHANGED_TRIGGERTriggers when a specific GitHub deployment's fields change. Monitors the following aspects of a single deployment: - ``environment`` -- the target environment name - ``original_environment`` -- the original environment name before normalization - ``description`` -- the human-readable deployment description - ``task`` -- the deployment task name - ``sha`` -- the commit SHA being deployed - ``ref`` -- the branch, tag, or SHA reference being deployed - ``updated_at`` -- the last-updated timestamp - ``transient_environment`` -- whether the environment is temporary - ``production_environment`` -- whether this is a production deployment When any of these fields change, an event is emitted containing the full current deployment details and a list of which fields changed.
Configuration
The unique numeric identifier of the deployment to monitor. Obtain this from the deployments listing endpoint ``GET /repos/{owner}/{repo}/deployments`` or from your CI/CD output.
Periodic Interval to Check for Updates & Send a Trigger in Minutes
GitHub username or organisation that owns the repository (e.g. 'octocat' or 'my-company').
Repository name without the .git extension (e.g. 'Hello-World' or 'my-project').
Payload
List of field names that changed since the previous poll. Possible values: 'environment', 'original_environment', 'description', 'task', 'sha', 'ref', 'updated_at', 'transient_environment', 'production_environment'. Use this to route your automation — for example, alert only when 'environment' changes to detect environment promotions.
ISO 8601 timestamp when the deployment was created.
Minimal details about the user or bot that created the deployment.
The canonicalised snapshot from the current poll.
Numeric ID of the deployment that changed.
Optional human-readable description of the deployment.
Target environment name (e.g. 'production', 'staging').
Event type identifier.
GraphQL node ID of the deployment.
Original environment name before any normalization.
Owner of the repository.
The canonicalised snapshot from the previous poll.
Whether this is a production environment deployment.
The ref (branch, tag, or SHA) that was deployed.
Repository name.
API URL for the repository.
Commit SHA that was deployed.
API URL for the deployment's status history.
Deployment task name (e.g. 'deploy').
Whether the environment is temporary (e.g. for PR previews).
ISO 8601 timestamp when the deployment was last updated.
API URL of the deployment resource.
GITHUB_DEPLOYMENT_STATUS_CREATEDTriggers when a new deployment status is created for a specific deployment. Fires an event for each newly created deployment status on the monitored deployment. Deployment statuses represent state transitions such as pending, in_progress, success, failure, error, inactive, and queued. The payload includes the status state, creator, environment, description, timestamps, and relevant URLs.
Configuration
The unique numeric ID of the deployment to monitor for new statuses.
Periodic Interval to Check for Updates & Send a Trigger in Minutes
The account owner (user or organization) of the repository.
The name of the repository (without .git extension).
Payload
ISO 8601 timestamp when the deployment status was created.
The user or bot who created this deployment status.
The ID of the deployment this status belongs to.
API URL for the associated deployment.
A short description of the status (max 140 characters).
The environment this deployment status targets.
The URL for accessing the deployment environment.
Event type identifier for this trigger.
Unique numeric ID of the deployment status.
The URL to view the full output from the deployment.
GraphQL node identifier for the deployment status.
The name of the repository.
The owner of the repository.
API URL for the repository this deployment status belongs to.
The state of the deployment status. One of: error, failure, inactive, pending, success, queued, in_progress.
The target URL associated with this status, typically pointing to the deployment output or logs.
ISO 8601 timestamp when the deployment status was last updated.
API URL for this deployment status resource.
GITHUB_FOLLOWER_EVENTTriggers when new followers are detected on your GitHub account.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
Payload
Username of the github follower
GITHUB_GIT_REFERENCE_CREATED_TRIGGERTriggers when a new Git reference (branch or tag) matching a specified prefix is created in a repository. Fires an event for each newly created branch or tag whose name matches the configured prefix. Use ``ref_prefix`` to control what is monitored: - ``heads/`` to watch all branches - ``heads/feature/`` to watch only feature branches - ``tags/`` to watch all tags - ``tags/v`` to watch tags starting with 'v' The payload includes the full reference name, node ID, the SHA and type of the Git object the reference points to, and the reference API URL.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
GitHub username or organisation that owns the repository (e.g. 'octocat' or 'microsoft').
Partial Git reference path prefix to match, without the 'refs/' prefix. Use 'heads/' to match branches (e.g. 'heads/feature/') or 'tags/' to match tags (e.g. 'tags/v'). Only references whose full name starts with 'refs/{ref_prefix}' will be monitored.
Repository name without the .git extension (e.g. 'Hello-World' or 'my-project').
Payload
Type of event that occurred.
The global node ID for the reference.
The SHA-1 hash of the Git object this reference points to.
The type of Git object (typically 'commit').
The API URL for the referenced Git object.
Owner of the repository.
The full Git reference name (e.g. 'refs/heads/feature-a' or 'refs/tags/v1.0').
The API URL for accessing this reference.
Repository name.
GITHUB_ISSUE_ADDED_EVENTTriggered when a new issue is added to the repository.
Configuration
Owner of the repository
Repository name
Payload
The action that was performed on the issue
The timestamp when the issue was created
The GitHub username of the user who created the issue
A detailed description of the issue
The unique ID assigned to the issue
The unique number assigned to the issue
The title of the issue
The GitHub URL of the issue
GITHUB_ISSUE_ASSIGNED_TO_ME_TRIGGERTriggers when a new issue is assigned to the authenticated user. Fires an event for each GitHub issue that is newly assigned to the authenticated user. Pull requests are automatically excluded -- only true issues are emitted. Issues can optionally be filtered by labels and state. The payload includes the issue number, title, body, state, labels, assignees, creator, repository details, and timestamps.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
A comma-separated list of label names to filter issues by. Only issues with ALL the specified labels will trigger events. Leave empty to receive all newly assigned issues regardless of labels.
Filter issues by state. Use 'open' to only receive open issues, 'closed' for closed issues, or 'all' for both.
Payload
GitHub users assigned to this issue.
The body text / description of the issue.
ISO 8601 timestamp when the issue was closed, if applicable.
Number of comments on the issue.
ISO 8601 timestamp when the issue was created.
The GitHub URL to view this issue.
The unique numeric ID of the issue.
Labels attached to the issue.
The issue number within the repository.
Minimal repository information attached to an issue.
The state of the issue: 'open' or 'closed'.
The title of the issue.
ISO 8601 timestamp when the issue was last updated.
The REST API URL for this issue.
The user who created the issue.
GITHUB_ISSUE_COMMENT_CHANGED_TRIGGERTriggers when a specific GitHub issue comment changes. Monitors the following fields for changes: - ``body`` -- the text content of the comment (detects edits) - ``updated_at`` -- the last-updated timestamp - ``reactions_*`` -- all individual reaction counts (thumbs up/down, laugh, confused, heart, hooray, eyes, rocket) and the total count When a change is detected, the payload includes the full current comment data plus a ``changed_fields`` list indicating exactly which fields were modified.
Configuration
The unique numeric identifier of the issue comment to monitor. You can obtain this from the comment's URL or via the GitHub API.
Periodic Interval to Check for Updates & Send a Trigger in Minutes
GitHub username or organisation that owns the repository (e.g. 'octocat' or 'microsoft').
Repository name without the .git extension (e.g. 'Hello-World' or 'vscode').
Payload
How the author is associated with the repository. Possible values: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER.
Current body (text) of the issue comment.
List of canonicalised field names that changed since the previous poll. Possible values: 'body', 'updated_at', 'reactions_total_count', 'reactions_plus_one', 'reactions_minus_one', 'reactions_laugh', 'reactions_confused', 'reactions_heart', 'reactions_hooray', 'reactions_eyes', 'reactions_rocket'.
Unique numeric ID of the issue comment.
ISO 8601 timestamp when the comment was created.
The canonicalised snapshot from the current poll.
Event type identifier.
Web URL to view the comment on GitHub.
GitHub API URL for the parent issue.
GraphQL node identifier of the comment.
Owner of the repository.
The canonicalised snapshot from the previous poll.
Reaction counts for the issue comment.
Repository name.
ISO 8601 timestamp when the comment was last updated.
GitHub API URL for the issue comment.
Condensed representation of the comment author.
GITHUB_ISSUE_COMMENT_CREATED_TRIGGERTriggers when a new comment is added to a specific GitHub issue. Only genuinely new comments are emitted; edits to existing comments do not produce duplicate events. The payload includes the comment ID, text body, author details, timestamps, and direct links to the comment on GitHub.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
The number that identifies the issue to monitor for new comments (e.g. 42). You can find it in the issue URL (github.com/owner/repo/issues/42).
GitHub username or organisation that owns the repository (e.g. 'octocat' or 'microsoft').
Repository name without the .git extension (e.g. 'Hello-World' or 'vscode').
Payload
The comment author's relationship to the repository. Possible values: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER.
The text content of the comment.
Unique identifier of the issue comment.
ISO 8601 timestamp when the comment was created.
Web URL to view the comment on GitHub.
The issue number this comment belongs to.
GitHub API URL for the parent issue.
GraphQL node ID of the comment.
Owner of the repository.
Repository name.
ISO 8601 timestamp when the comment was last updated.
GitHub API URL for the comment.
GitHub user information associated with a comment.
GITHUB_ISSUE_CREATED_TRIGGERTriggers when a new issue is created in a GitHub repository. Pull requests are automatically excluded -- only true issues produce events. Results can be filtered by labels, assignee, creator, and mentioned user. The payload includes the issue number, title, body, state, labels, assignees, comment count, creator details, timestamps, and direct links to the issue on GitHub.
Configuration
Filter issues assigned to a specific GitHub username. Use 'none' for unassigned issues, '*' for any assigned issue. Leave empty to receive issues regardless of assignee.
Filter issues created by a specific GitHub username. Leave empty to receive issues from any creator.
Periodic Interval to Check for Updates & Send a Trigger in Minutes
A comma-separated list of label names to filter issues by. Only issues with ALL the specified labels will trigger events. Leave empty to receive all new issues regardless of labels.
Filter issues where the given GitHub username is mentioned. Leave empty to receive all new issues.
The account owner of the repository (username or organization name). Must contain only alphanumeric characters and hyphens, max 39 characters.
The name of the repository without the .git extension. Must contain only alphanumeric characters, hyphens, underscores, and periods.
Issue state to monitor: 'open', 'closed', or 'all'. Defaults to 'open'.
Payload
GitHub users assigned to this issue.
The body text / description of the issue.
ISO 8601 timestamp when the issue was closed, if applicable.
Number of comments on the issue.
ISO 8601 timestamp when the issue was created.
The GitHub URL to view this issue.
The unique numeric ID of the issue.
True if this item is actually a pull request. GitHub's issues API also returns pull requests; this flag distinguishes them.
Labels attached to the issue.
The issue number within the repository.
The name of the repository the issue belongs to.
The owner of the repository the issue belongs to.
The state of the issue: 'open' or 'closed'.
The title of the issue.
ISO 8601 timestamp when the issue was last updated.
The REST API URL for this issue.
The user who created the issue.
GITHUB_ISSUE_EVENT_OCCURRED_TRIGGERTriggers when a new issue event occurs in a GitHub repository. Covers all issue timeline events such as issues being closed, reopened, assigned, unassigned, labeled, unlabeled, milestoned, demilestoned, renamed, locked, or unlocked. Events can optionally be filtered by type. The payload includes the event type, timestamp, the actor who triggered the event, the affected issue details, and any associated commit references.
Configuration
Comma-separated list of event types to filter (e.g., 'closed,labeled,assigned'). Leave empty to receive all issue events. Common values: closed, reopened, assigned, unassigned, labeled, unlabeled, milestoned, demilestoned, renamed, locked, unlocked.
Periodic Interval to Check for Updates & Send a Trigger in Minutes
The account owner of the repository (username or organization name). Must contain only alphanumeric characters and hyphens, max 39 characters.
The name of the repository without the .git extension. Must contain only alphanumeric characters, hyphens, underscores, and periods.
Payload
Minimal GitHub user information for the event actor.
SHA of the commit that referenced this issue, if applicable.
API URL for the associated commit, if applicable.
ISO 8601 timestamp when the event was created.
The type of event (e.g., closed, reopened, assigned, unassigned, labeled, unlabeled, milestoned, demilestoned, renamed, locked, unlocked).
The unique numeric ID of the issue event.
Minimal issue information embedded in the event.
GraphQL global node identifier of the event.
The name of the repository the event belongs to.
The owner of the repository the event belongs to.
The REST API URL for this event.
GITHUB_ISSUE_LABEL_CHANGED_TRIGGERTriggers when the labels on a specific GitHub issue change. Fires whenever a label is added to, removed from, or has its metadata (color, description) modified on the monitored issue. The payload includes: - ``current_labels`` -- the full set of labels currently on the issue - ``added_labels`` -- labels that were newly added - ``removed_label_names`` -- names of labels that were removed - ``changed_label_names`` -- labels whose metadata changed without being added or removed
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
The unique number of the GitHub issue to monitor for label changes. You can find this number in the issue's URL: https://github.com/{owner}/{repo}/issues/{issue_number}
The account owner of the repository (username or organization name). This is not case-sensitive. For example: 'octocat' or 'my-organization'.
The name of the repository without the `.git` extension. This is not case-sensitive.
Payload
Labels that were added to the issue since the previous poll.
Names of labels whose metadata (color, description) changed since the previous poll without being added/removed.
The full current set of labels on the issue after the change.
Event type identifier.
The number of the issue whose labels changed.
The account owner of the repository (username or org).
Names of labels that were removed from the issue since the previous poll.
The repository name.
GITHUB_ISSUE_STATE_CHANGED_TRIGGERTriggers when a specific GitHub issue changes any of its tracked properties. Monitored properties: state (open/closed), state_reason, title, body, assignees, labels, milestone, lock status, active_lock_reason, comment count, and closed_at timestamp. When a change is detected, the payload includes the full current issue details, the list of changed field names, and their previous values.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
The identifying number of the issue to monitor. This is the number shown next to the issue title (e.g., #42) or visible in the issue URL.
The account owner of the repository (username or organization name). Must contain only alphanumeric characters and hyphens, max 39 characters.
The name of the repository without the .git extension. Must contain only alphanumeric characters, hyphens, underscores, and periods.
Payload
The reason the issue is locked, if locked.
GitHub users currently assigned to this issue.
The current body text / description of the issue.
List of field names that changed since the last poll.
ISO 8601 timestamp when the issue was closed, if applicable.
Number of comments on the issue.
ISO 8601 timestamp when the issue was created.
The GitHub URL to view this issue.
The unique numeric ID of the issue.
Labels currently attached to the issue.
Whether the issue is locked.
The issue number within the repository.
Previous string-serialized values of the changed fields.
The name of the repository the issue belongs to.
The owner of the repository the issue belongs to.
The current state of the issue: 'open' or 'closed'.
The reason for the current state. Possible values: completed, reopened, not_planned, duplicate, or null.
The current title of the issue.
ISO 8601 timestamp when the issue was last updated.
The REST API URL for this issue.
The user who created the issue.
GITHUB_ISSUE_UPDATED_TRIGGERTriggers when an existing issue is updated in a GitHub repository. Monitors issues for any changes such as title edits, body edits, label changes, assignee changes, state transitions (opening, closing, reopening), milestone updates, and comment additions. Only pre-existing issues that receive updates are emitted; newly created issues are excluded. Pull requests are also excluded -- only true issues fire events.
Configuration
Filter issues assigned to a specific GitHub username. Use 'none' for unassigned issues, '*' for any assigned issue. Leave empty to receive issues regardless of assignee.
Periodic Interval to Check for Updates & Send a Trigger in Minutes
A comma-separated list of label names to filter issues by. Only issues with ALL the specified labels will trigger events. Leave empty to receive events for all issues regardless of labels.
The account owner of the repository (username or organization name). Must contain only alphanumeric characters and hyphens, max 39 characters.
The name of the repository without the .git extension. Must contain only alphanumeric characters, hyphens, underscores, and periods.
Filter by issue state. Use 'open' for open issues only, 'closed' for closed issues, or 'all' for both. Defaults to 'all' so updates to any issue (e.g., closing an issue) are captured.
Payload
GitHub users assigned to this issue.
The body text / description of the issue.
ISO 8601 timestamp when the issue was closed, if applicable.
Number of comments on the issue.
ISO 8601 timestamp when the issue was created.
The GitHub URL to view this issue.
The unique numeric ID of the issue.
Labels attached to the issue.
The issue number within the repository.
The name of the repository the issue belongs to.
The owner of the repository the issue belongs to.
The state of the issue: 'open' or 'closed'.
Reason for the current state (completed, not_planned, reopened, or null).
The title of the issue.
ISO 8601 timestamp when the issue was last updated.
The REST API URL for this issue.
The user who created the issue.
GITHUB_LABEL_ADDED_EVENTTriggered when a new label is added to a pull request.
Configuration
Owner of the repository
Repository name
Payload
The action that was performed on the label
The name of the label that was added
The timestamp when the label was added
The GitHub username of the user who added the label
The unique number assigned to the pull request
The title of the pull request
The GitHub URL of the pull request
GITHUB_NEW_STARGAZER_ADDED_TRIGGERTriggers when a new user stars a GitHub repository. Emits an event for each new stargazer detected on the monitored repository.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
GitHub username or organisation that owns the repository (e.g. 'octocat' or 'microsoft').
Repository name without the .git extension (e.g. 'Hello-World' or 'vscode').
Payload
GitHub API URL for the stargazer's user resource.
URL to the stargazer's avatar image.
Type of event that occurred.
GitHub profile URL of the stargazer.
GitHub username of the user who starred the repository.
Owner of the repository.
Repository name.
Whether the stargazer is a GitHub site administrator.
Unique numeric identifier for the user who starred the repository.
Type of the GitHub account (e.g. 'User' or 'Organization').
GITHUB_PR_REVIEW_COMMENT_CREATED_TRIGGERTriggers when a new inline review comment is added to a specific GitHub pull request. Monitors all review comments across all reviews on the specified pull request and emits an event for each newly created comment. Edits to existing comments do not fire new events.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
GitHub username or organisation that owns the repository (e.g. 'octocat' or 'microsoft').
The number that identifies the pull request to monitor (e.g. 42). You can find it in the PR URL (github.com/owner/repo/pull/42).
Repository name without the .git extension (e.g. 'Hello-World' or 'vscode').
Payload
The comment author's relationship to the repository. Possible values: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER.
The text content of the review comment.
Unique identifier of the review comment.
The SHA of the commit to which the comment applies.
ISO 8601 timestamp when the comment was created.
The diff hunk of the file that the comment refers to.
Web URL to view the comment on GitHub.
The comment ID this comment replies to, if any.
The line of the blob to which the comment applies. The last line of the range for a multi-line comment.
GraphQL node ID of the comment.
The SHA of the original commit to which the comment applies.
The original line index in the diff.
The original first line of the range for a multi-line comment.
Owner of the repository.
The relative path of the file to which the comment applies.
The pull request number this comment belongs to.
The ID of the pull request review the comment belongs to, if any.
GitHub API URL for the parent pull request.
Repository name.
The side of the diff to which the comment applies (LEFT or RIGHT).
The first line of the range for a multi-line comment.
The side of the diff where the multi-line comment range starts (LEFT or RIGHT).
The level at which the comment is targeted: 'line' or 'file'.
ISO 8601 timestamp when the comment was last updated.
GitHub API URL for the review comment.
GitHub user information associated with a pull request review comment.
GITHUB_PULL_REQUEST_COMMIT_ADDED_TRIGGERTriggers when a new commit is pushed to a specific pull request. Monitors all commits on the specified pull request and emits an event for each newly added commit. This covers force-pushes and additional commits pushed to the PR's head branch.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
The account owner of the repository (username or organization name). Case-insensitive.
The number of the pull request to monitor for new commits.
The name of the repository without the .git extension. Case-insensitive.
Payload
Minimal GitHub user info (author or committer).
API URL for comments on this commit.
Detailed metadata embedded in the commit object.
Minimal GitHub user info (author or committer).
GitHub URL to view the commit.
The GraphQL node ID of the commit.
Parent commits of this commit.
The pull request number this commit belongs to.
The name of the repository (from config).
The owner of the repository (from config).
The commit SHA.
API URL for this commit.
GITHUB_PULL_REQUEST_CREATEDTriggers when a new pull request is created in GitHub, matching the optional configured filters. Emits an event for each newly created pull request. Supports filtering by repository, owner/organisation, author, assignee, label, state, base branch, head branch, and draft status.
Configuration
Only emit events for pull requests assigned to this GitHub username. Use '@me' to match the authenticated user.
Only emit events for pull requests created by this GitHub username. Must be a valid GitHub login (alphanumeric + hyphens only, max 39 chars).
Only emit events for pull requests targeting this base branch (e.g., 'main' or 'develop').
Only emit events for pull requests whose source branch matches this name (e.g., 'feature/login').
Periodic Interval to Check for Updates & Send a Trigger in Minutes
Filter by draft status. Set to True to receive events only for draft PRs, False for non-draft PRs, or leave blank to receive both.
Only emit events for pull requests that carry this label name (e.g., 'bug', 'enhancement').
Restrict the search to all repositories belonging to a GitHub user or organisation (e.g., 'facebook' or 'microsoft'). Ignored when 'repo' is also provided.
Restrict the search to a specific repository. Must be in 'owner/repo' format (e.g., 'facebook/react'). Leave blank to search across all repositories accessible to the account.
Pull request state to monitor: 'open', 'closed', or 'all'. Defaults to 'open'.
Payload
GitHub profile URL of the pull request author.
GitHub username of the pull request author.
Body/description of the pull request in markdown format.
ISO 8601 timestamp when the pull request was closed, null if open.
Number of comments on the pull request.
ISO 8601 timestamp when the pull request was created.
Whether the pull request is marked as a draft.
Event type identifier for this trigger.
GitHub web interface URL to view the pull request.
Names of the labels attached to this pull request.
ISO 8601 timestamp when the pull request was merged, null if not merged.
GraphQL node identifier for the pull request.
Pull request number within the repository.
Unique numeric identifier of the pull request (as string).
GitHub API URL for the repository the pull request belongs to.
State of the pull request: 'open' or 'closed'.
Title of the pull request.
ISO 8601 timestamp when the pull request was last updated.
GITHUB_PULL_REQUEST_EVENTTriggered when a pull request is opened, closed, or synchronized.
Configuration
Owner of the repository
Repository name
Payload
The action that was performed on the pull request
The timestamp when the pull request was created
The GitHub username of the user who created the pull request
A detailed description of the pull request
The unique number assigned to the pull request
The title of the pull request
The GitHub URL of the pull request
GITHUB_PULL_REQUEST_REVIEWERS_CHANGED_TRIGGERTriggers when the list of requested reviewers (users or teams) for a pull request changes — for example when a reviewer is added, removed, or re-requested. The payload includes the full current reviewer list (users and teams with details), which reviewers were added, which were removed, and the previous reviewer list for reference.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
GitHub username or organisation that owns the repository (e.g. 'octocat' or 'microsoft').
The numeric identifier of the pull request to monitor (e.g. 42). You can find this in the pull request URL.
Repository name without the .git extension (e.g. 'Hello-World' or 'my-project').
Payload
Sorted list of team slugs currently requested to review.
Full details of teams currently requested to review.
Sorted list of GitHub user logins currently requested to review.
Full details of users currently requested to review.
Event type identifier.
Owner of the repository.
Sorted list of team slugs from the previous poll.
Sorted list of user logins from the previous poll.
The numeric identifier of the pull request.
Repository name.
Team slugs that were newly added as requested reviewers.
Team slugs that were removed from requested reviewers.
User logins that were newly added as requested reviewers.
User logins that were removed from requested reviewers.
GITHUB_PULL_REQUEST_REVIEW_SUBMITTED_TRIGGERTriggers when a new review is submitted for a GitHub pull request. Emits an event for each newly submitted review on the monitored pull request, covering all review types: APPROVED, CHANGES_REQUESTED, COMMENTED, and DISMISSED.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
GitHub username or organisation that owns the repository (e.g. 'octocat' or 'microsoft').
The number of the pull request to monitor for new reviews.
Repository name without the .git extension (e.g. 'Hello-World' or 'vscode').
Payload
How the reviewer is associated with the repository (e.g. COLLABORATOR, CONTRIBUTOR, MEMBER, NONE, OWNER).
The body text of the review.
The commit SHA that was reviewed.
Type of event that occurred.
Web URL for the review.
GraphQL node identifier of the review.
Owner of the repository.
The number of the pull request being reviewed.
API URL for the associated pull request.
Repository name.
Unique numeric identifier of the review.
Minimal representation of the reviewer user.
State of the review. Possible values: APPROVED, CHANGES_REQUESTED, COMMENTED, DISMISSED, PENDING.
ISO 8601 timestamp of when the review was submitted.
GITHUB_PULL_REQUEST_STATE_CHANGED_TRIGGERTriggers when a specific GitHub pull request changes any of these tracked properties: state (open/closed), title, body, draft status, lock status, merge status, assignees, labels, requested reviewers, or milestone. The payload includes the full current PR details, the list of changed field names, and their previous values.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
The account owner of the repository (username or organization name). Must contain only alphanumeric characters and hyphens, max 39 characters.
The identifying number of the pull request to monitor. This is the number shown next to the PR title (e.g., #42) or visible in the pull request URL.
The name of the repository without the .git extension. Must contain only alphanumeric characters, hyphens, underscores, and periods.
Payload
The reason the pull request is locked, if locked.
GitHub users currently assigned to this pull request.
The current body / description of the pull request.
List of field names that changed since the last poll.
ISO 8601 timestamp when the pull request was closed, if applicable.
ISO 8601 timestamp when the pull request was created.
Whether the pull request is a draft.
The GitHub URL to view this pull request.
The unique numeric ID of the pull request.
Labels currently attached to the pull request.
Whether the pull request is locked.
SHA of the merge commit, if merged.
Whether the pull request has been merged.
ISO 8601 timestamp when the pull request was merged, if applicable.
Minimal GitHub user information attached to a pull request.
The milestone title associated with the pull request, if any.
The PR number within the repository.
Previous string-serialized values of the changed fields.
The name of the repository the pull request belongs to.
The owner of the repository the pull request belongs to.
GitHub users whose review is currently requested.
The current state of the pull request: 'open' or 'closed'.
The current title of the pull request.
ISO 8601 timestamp when the pull request was last updated.
The REST API URL for this pull request.
The user who created the pull request.
GITHUB_PULL_REQUEST_UPDATEDTriggers when an existing pull request is updated in a GitHub repository. Updates include title edits, description changes, label changes, assignee changes, reviewer requests, draft status changes, base branch changes, being closed, merged, or reopened. Only pre-existing PRs that receive an update will fire the trigger; newly created PRs are excluded. Supports optional filters: state, base branch, head branch, author, label, and draft status.
Configuration
Only emit events for pull requests authored by this GitHub username. Leave blank to watch PRs from any author.
Only emit events for pull requests targeting this base branch (the branch being merged into). Leave blank to watch all base branches.
Filter by draft status. Set to True to only watch draft PRs, False for non-draft PRs, or leave blank (None) to watch both.
Only emit events for pull requests coming from this head branch (the branch being merged). Supports the 'user:branch' format to filter across forks. Leave blank to watch all head branches.
Periodic Interval to Check for Updates & Send a Trigger in Minutes
Only emit events for pull requests carrying this exact label name. Leave blank to watch PRs regardless of labels.
The account owner of the repository (GitHub username or organization name). Do not include the repository name here.
The name of the repository to watch for updated pull requests. Do not include the owner prefix.
Filter pull requests by state. Use 'open' for open PRs only, 'closed' for closed (merged or unmerged) PRs, or 'all' to catch updates to PRs in any state (e.g., a PR being merged or closed). Defaults to 'all'.
Payload
List of GitHub users currently assigned to the pull request.
Author's relationship to the repository: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, or OWNER.
Branch information (head or base) for a pull request.
The description / body of the pull request in markdown format.
ISO 8601 timestamp when the pull request was closed, null if still open.
ISO 8601 timestamp when the pull request was created.
Whether the pull request is marked as a draft.
Event type identifier for this trigger.
Branch information (head or base) for a pull request.
GitHub web interface URL to view the pull request.
The unique numeric ID of the pull request across all of GitHub.
Labels attached to the pull request.
Whether the pull request conversation is locked.
SHA of the merge commit. Present before merging as a test-merge SHA; set to the actual merge commit SHA after merge.
ISO 8601 timestamp when the pull request was merged, null if not merged.
The pull request number within the repository.
The name of the repository.
The owner (user or organization) of the repository.
List of users requested to review the pull request.
Current state of the pull request: 'open' or 'closed'.
The title of the pull request.
ISO 8601 timestamp when the pull request was last updated.
GitHub REST API URL for this pull request.
GitHub user information attached to a pull request.
GITHUB_README_CHANGED_TRIGGERTriggers when the README file in a specific repository directory changes. Monitors the README in a configurable directory and branch/tag/commit. The payload includes the current README metadata (filename, path, SHA, size, URLs), the previous and current git blob SHAs, and a list of which tracked fields changed.
Configuration
The directory path within the repository whose README to monitor. Use '.' or leave blank to monitor the root README. For a subdirectory, provide the relative path (e.g. 'docs' or 'src/api').
Periodic Interval to Check for Updates & Send a Trigger in Minutes
GitHub username or organisation that owns the repository (e.g. 'octocat' or 'microsoft').
Optional Git ref (branch, tag, or commit SHA) to read the README from. Leave blank to use the repository's default branch.
Repository name without the .git extension (e.g. 'Hello-World' or 'my-project').
Payload
List of tracked field names that changed since the previous poll. Possible values: 'sha', 'size', 'name', 'path'.
The git blob SHA observed in the current poll (after the change).
The canonicalised snapshot from the current poll.
Directory path that was monitored.
URL to download the raw README content.
Encoding used for the README content (typically 'base64').
Event type identifier.
GitHub API URL to the underlying git blob.
URL to view the README on GitHub.
Filename of the README (e.g. 'README.md').
Owner of the repository.
Full path of the README within the repository.
The git blob SHA observed in the previous poll (before the change).
The canonicalised snapshot from the previous poll.
Repository name.
Current git blob SHA of the README content.
Current size of the README file in bytes.
GitHub API URL for the README resource.
GITHUB_RELEASE_ASSET_ADDED_TRIGGERTriggers when a new asset is added to a specific GitHub release. Monitors a single release (identified by release ID) for newly uploaded assets such as binaries, archives, or checksum files. One event is emitted per new asset, containing full asset metadata.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
The GitHub username or organization name that owns the repository (e.g. 'octocat' or 'my-organization').
The unique numeric identifier of the release to monitor for new assets. You can obtain this by listing releases for the repository.
The name of the repository that contains the release to monitor (without the .git extension, e.g. 'Hello-World').
Payload
Unique numeric identifier of the newly added release asset.
Direct download URL for the asset accessible in a browser.
MIME type of the asset (e.g. 'application/zip', 'text/plain').
ISO 8601 timestamp of when the asset was created.
SHA256 hash of the asset file for integrity verification.
Number of times the asset has been downloaded.
Event type identifier for this trigger.
An optional label providing additional context for the asset.
The file name of the asset.
GraphQL node identifier for the release asset.
The GitHub username or organization that owns the repository.
The numeric ID of the release this asset belongs to.
The name of the repository containing this release.
Size of the asset file in bytes.
State of the release asset (e.g. 'uploaded' or 'open').
ISO 8601 timestamp of when the asset was last updated.
Numeric GitHub user ID of the uploader.
GitHub login (username) of the user who uploaded the asset.
GitHub REST API URL for this release asset.
GITHUB_RELEASE_STATE_CHANGED_TRIGGERTriggers when a specific GitHub release (identified by tag name) changes. Monitors the release title, body/notes, draft flag, prerelease flag, published timestamp, target branch/commit, and the set of attached assets. The payload includes the full current release details, a list of which fields changed, and the previous values for comparison.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
GitHub username or organisation that owns the repository (e.g. 'octocat' or 'microsoft').
Repository name without the .git extension (e.g. 'Hello-World' or 'my-project').
The exact Git tag name of the release to monitor (e.g. 'v1.0.0'). This identifies the specific release by its tag.
Payload
Current list of release assets.
Current release body/notes in markdown format.
List of field names that changed since the previous poll. Possible values: 'name', 'body', 'draft', 'prerelease', 'published_at', 'target_commitish', 'asset_ids'.
The canonicalised snapshot from the current poll.
Whether the release is currently a draft.
Event type identifier.
Web URL to view the release on GitHub.
Current release name/title.
Owner of the repository.
Whether the release is currently marked as a prerelease.
The canonicalised snapshot from the previous poll.
ISO 8601 timestamp when the release was published (null for drafts).
Numeric ID of the release that changed.
Repository name.
Git tag name for the release.
The branch or commit SHA the release tag points to.
GITHUB_REPOSITORY_CONTENT_CHANGED_TRIGGERTriggers when the content of a file or directory in a GitHub repository changes. Monitors a specified path within a repository on a given branch or tag. For a single file, fires ``content_changed`` when the file is modified. For a directory, fires ``content_changed``, ``content_added``, or ``content_removed`` for modified, new, or deleted entries respectively. content.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
GitHub username or organisation that owns the repository (e.g. 'octocat' or 'microsoft').
Path to the file or directory to monitor within the repository. Use an empty string (default) to monitor the root directory. For a specific file use its full path (e.g. 'README.md', 'src/main.py'). For a directory use its path (e.g. 'src', 'docs/api').
The git reference (branch name, tag name, or commit SHA) to monitor. If omitted the repository's default branch is used.
Repository name without the .git extension (e.g. 'Hello-World' or 'my-project').
Payload
Type of change: 'content_changed', 'content_added', or 'content_removed'.
Metadata snapshot of the content item that changed, was added, or was removed.
The file or directory path being monitored.
Owner of the repository.
SHA of the item before the change. Non-empty only for 'content_changed' events.
The git reference (branch/tag/SHA) that was monitored. Empty string means the repository's default branch was used.
Repository name.
GITHUB_REPOSITORY_NOTIFICATION_RECEIVED_TRIGGERTriggers when a new or newly updated notification thread appears for a specific GitHub repository. Monitors notifications for issues, pull requests, commits, releases, check suites, security alerts, and other repository activity. Supports filtering by read/unread status and by direct participation. Requires a Personal Access Token (classic) with the ``notifications``
Configuration
If true, also return notifications that have already been marked as read. Default (false) shows only unread notifications.
Periodic Interval to Check for Updates & Send a Trigger in Minutes
The account owner of the repository (username or organization). Not case sensitive.
If true, only return notifications where the authenticated user is directly participating or mentioned.
The name of the repository (without the .git extension). Not case sensitive.
Payload
Notification thread ID.
ISO 8601 timestamp of when the thread was last read, or null.
Reason the authenticated user received the notification (e.g., subscribed, mentioned, author, assign, review_requested, comment, ci_activity, security_alert, state_change, team_mention).
Repository the notification belongs to.
Subject of the notification thread.
API URL for managing the thread subscription.
Whether the notification thread is unread.
ISO 8601 timestamp of when the notification thread was last updated.
API URL for this notification thread.
GITHUB_REPOSITORY_TAG_CREATED_TRIGGERTriggers when a new tag is created in a GitHub repository. Monitors the repository's tags and fires an event for each newly created tag. The payload includes the tag name, the commit SHA and URL it points to, and archive download URLs.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
GitHub username or organisation that owns the repository (e.g. 'octocat' or 'microsoft').
Repository name without the .git extension (e.g. 'Hello-World' or 'my-project').
Payload
The SHA of the commit the tag points to.
The API URL of the commit the tag points to.
Type of event that occurred.
The GraphQL node ID of the tag reference.
Owner of the repository.
Repository name.
The name of the newly created tag.
URL to download a tarball archive of the repository at this tag.
URL to download a zipball archive of the repository at this tag.
GITHUB_SECRET_SCANNING_ALERT_DETECTED_TRIGGERTriggers when a new secret scanning alert is detected in a GitHub repository. Monitors open secret scanning alerts and fires an event for each newly detected alert. Supports filtering by secret type (e.g., personal access tokens, AWS keys) and by token validity status (active, inactive, unknown). The payload includes the alert number, secret type, validity status, resolution state, timestamps, URLs, and flags for push protection bypass, public exposure, and multi-repo detection.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
The account owner of the repository. The name is not case sensitive.
The name of the repository without the .git extension. The name is not case sensitive.
Comma-separated list of secret types to filter by (e.g., 'github_personal_access_token,aws_access_key_id'). Leave empty to monitor all secret types.
Filter by token validity status: 'active' (token still valid), 'inactive' (token revoked/expired), or 'unknown'. Leave empty to monitor all validity states.
Payload
The ISO 8601 timestamp when the alert was created.
The GitHub web URL for the alert.
The REST API URL for the locations where the secret was detected.
Whether the secret was found in multiple repositories.
The security alert number identifier.
Whether the secret was found publicly exposed.
Whether push protection was bypassed for this secret.
The ISO 8601 timestamp when push protection was bypassed.
The resolution when the alert is resolved: 'false_positive', 'wont_fix', 'revoked', 'pattern_edited', 'pattern_deleted', or 'used_in_tests'.
The ISO 8601 timestamp when the alert was resolved, if applicable.
The type of secret that was detected (e.g., 'github_personal_access_token', 'aws_access_key_id').
The human-readable display name of the secret type.
The state of the alert: 'open' or 'resolved'.
The ISO 8601 timestamp when the alert was last updated.
The REST API URL for the alert.
The validity status of the detected token: 'active', 'inactive', or 'unknown'.
GITHUB_STAR_ADDED_EVENTTriggered when a new star is added to the repository.
Configuration
Owner of the repository
Repository name
Payload
The action that was performed on the star
The unique ID assigned to the repository
The name of the repository
The GitHub URL of the repository
The timestamp when the star was added
The GitHub username of the user who added the star
GITHUB_WORKFLOW_ADDED_TRIGGERTriggers when a new GitHub Actions workflow is added to a repository. Monitors a repository's GitHub Actions workflows and fires an event for each newly added workflow. The payload includes the workflow's name, file path, state, creation and update timestamps, and URLs for the API, web interface, and status badge.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
The GitHub username or organization name that owns the repository (e.g. 'octocat' or 'my-organization').
The name of the repository to monitor for new workflows (without the .git extension, e.g. 'Hello-World').
Payload
URL for the workflow status badge image.
ISO 8601 timestamp of when the workflow was created.
ISO 8601 timestamp of when the workflow was deleted, or null if not deleted.
Type of event that occurred.
GitHub web interface URL where the workflow can be viewed.
The name of the workflow as defined in the workflow file.
GraphQL node identifier for the workflow.
The GitHub username or organization that owns the repository.
The path to the workflow file within the repository (e.g. '.github/workflows/ci.yaml').
The name of the repository the workflow was added to.
Current state of the workflow. Possible values: active, deleted, disabled_fork, disabled_inactivity, disabled_manually.
ISO 8601 timestamp of when the workflow was last updated.
API endpoint URL for accessing this specific workflow.
Unique numeric identifier of the newly added workflow.
GITHUB_WORKFLOW_JOB_ADDED_TRIGGERTriggers when a new job appears in a specific GitHub Actions workflow run. This is useful for detecting matrix-expanded jobs that are added after the initial workflow run creation, or any other scenario where jobs are dynamically added to an existing run.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
GitHub username or organisation that owns the repository (e.g. 'octocat' or 'microsoft'). Not case-sensitive.
Repository name without the .git extension (e.g. 'Hello-World' or 'my-project'). Not case-sensitive.
The unique identifier of the workflow run to monitor. You can find this in the URL of the workflow run page on GitHub (e.g. https://github.com/owner/repo/actions/runs/123456789).
Payload
The API URL of the check run associated with this job.
ISO 8601 timestamp of when the job completed.
The outcome of the job after completion (e.g. success, failure). Null if the job has not concluded.
ISO 8601 timestamp of when the job was created.
Type of event that occurred.
The branch name associated with this job.
The SHA of the commit being built in this job.
The GitHub URL to view the job in the browser.
The unique identifier of the job.
The display name of the job.
The API URL to retrieve details about this job.
Runner labels used to identify the type of runner for this job.
The GraphQL node identifier for this job.
Owner of the repository.
Repository name.
The attempt number of the associated workflow run, starting at 1.
The workflow run ID this job belongs to.
The API URL of the workflow run.
The identifier of the runner group executing this job.
The name of the runner group executing this job.
The identifier of the runner executing this job.
The name of the runner executing this job.
ISO 8601 timestamp of when the job started.
The current lifecycle phase of the job (e.g. queued, in_progress, completed).
The individual steps that make up this job.
The name of the workflow this job is part of.
GITHUB_WORKFLOW_JOB_STATE_CHANGEDTriggers when the status, conclusion, timestamps, runner assignment, or step details of a specific GitHub Actions workflow job change between polls. The payload includes the full current job state, a list of which fields changed, and the previous status/conclusion values for easy comparison.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
The unique numerical identifier of the GitHub Actions workflow job to monitor. You can find the job ID from the GitHub Actions UI URL or via the List Jobs for a Workflow Run API.
The account owner of the repository (GitHub username or organization name). Do not include the repository name here.
The name of the repository that contains the workflow job to watch. Do not include the owner prefix.
Payload
List of field names that changed compared to the previous snapshot. Empty on the very first event (initial state capture is skipped).
GitHub REST API URL for the check run.
ISO 8601 timestamp when the job finished. Null if still running.
Outcome of the job after completion: success, failure, neutral, cancelled, skipped, timed_out, or action_required. Null while running.
ISO 8601 timestamp when the job was created.
Event type identifier for this trigger.
Branch the job ran on.
SHA of the commit being run.
GitHub web UI URL to view this job.
Unique numeric identifier of the workflow job.
Runner labels from the runs-on attribute.
Name of the job.
Owner of the repository.
Previous job conclusion before this change.
Previous job status before this change.
Repository name.
Attempt number of the parent workflow run.
ID of the parent workflow run.
ID of the runner group. Null while queued.
Name of the runner group. Null while queued.
ID of the runner executing the job. Null while queued.
Name of the runner executing the job. Null while queued.
ISO 8601 timestamp when the job started.
Current status of the job: queued, in_progress, or completed.
Current step details for the job.
GitHub REST API URL for this job.
Name of the workflow.
GITHUB_WORKFLOW_RUN_ARTIFACT_ADDEDTriggers when a new artifact is uploaded to a specific GitHub Actions workflow run. Monitors a single workflow run for newly added artifacts such as build outputs, test results, or coverage reports. Each new artifact detected fires a separate event.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
Account owner of the repository (GitHub username or organization name).
Repository name without the .git extension.
Unique identifier of the workflow run to monitor for new artifacts.
Payload
Direct URL to download the artifact archive as a ZIP file.
Timestamp when the artifact was created.
SHA256 digest of the artifact (available for upload-artifact v4+).
Whether or not the artifact has expired.
Timestamp when the artifact will expire.
Unique identifier for the artifact.
The name of the artifact.
GraphQL node identifier for the artifact.
The size in bytes of the artifact.
Timestamp when the artifact was last updated.
API URL for accessing the artifact.
Metadata about the workflow run that created the artifact.
GITHUB_WORKFLOW_RUN_CREATEDTriggers when a new workflow run is created in a GitHub repository. Monitors the repository for any new workflow runs and fires an event for each one. Optional filters allow narrowing to a specific branch, actor, or event type.
Configuration
Filter workflow runs triggered by a specific GitHub user login. Leave blank to monitor runs triggered by any user.
Filter workflow runs to a specific branch name. Leave blank to monitor runs on all branches.
Filter workflow runs triggered by a specific event type (e.g. 'push', 'pull_request', 'schedule'). Leave blank to monitor runs triggered by any event.
Periodic Interval to Check for Updates & Send a Trigger in Minutes
The account owner of the repository (GitHub username or organization name). Do not include the repository name here.
The name of the repository to watch for new workflow runs. Do not include the owner prefix.
Payload
GitHub user who triggered the workflow run.
Conclusion of the workflow run (null if not completed).
ISO 8601 timestamp when the workflow run was created.
Event-specific title associated with the run or the value of run-name if set in the workflow file.
Name of the event that triggered the workflow run.
Event type identifier for this trigger.
Name of the branch that triggered the workflow run.
SHA of the commit that triggered the workflow run.
GitHub web UI URL to view the workflow run.
API URL to retrieve jobs for this workflow run.
API URL to download logs for this workflow run.
Name of the workflow run.
GraphQL node ID for the workflow run.
Owner of the repository.
Path to the workflow file in the repository.
Repository name.
Attempt number of this run (increments with re-runs).
Unique numeric identifier of the workflow run.
Sequential run number for this workflow.
ISO 8601 timestamp when the workflow run actually started execution.
Current status of the workflow run.
ISO 8601 timestamp when the workflow run was last updated.
GitHub REST API URL for this workflow run.
ID of the workflow definition.
GITHUB_WORKFLOW_RUN_STATE_CHANGED_TRIGGERTriggers when a GitHub Actions workflow run's status or conclusion changes. Monitors a single workflow run and fires an event whenever it transitions between states (e.g., queued to in_progress, or in_progress to completed) or when its conclusion is set (e.g., success, failure, cancelled).
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
GitHub username or organisation that owns the repository (e.g. 'octocat' or 'microsoft').
Repository name without the .git extension (e.g. 'Hello-World' or 'my-project').
The unique numeric identifier of the workflow run to monitor. You can find this in the URL of a workflow run on GitHub: https://github.com/{owner}/{repo}/actions/runs/{run_id}
Payload
List of state field names that changed since the previous poll. Possible values: 'status', 'conclusion'.
Current conclusion of the workflow run. One of: success, failure, neutral, cancelled, skipped, timed_out, action_required, or null if not yet completed.
Timestamp when the workflow run was created (ISO 8601).
The canonicalised state snapshot from the current poll.
Display title of the workflow run.
The event that triggered the workflow run.
Event type identifier.
Name of the branch the workflow ran on.
SHA of the head commit that triggered the workflow run.
URL to view the workflow run on GitHub.
Name of the workflow.
Owner of the repository.
The conclusion observed in the previous poll (before the change).
The canonicalised state snapshot from the previous poll.
The status observed in the previous poll (before the change).
Repository name.
Attempt number of the run (1 for first attempt).
Unique identifier of the workflow run.
Auto-incrementing run number for the workflow.
Timestamp when the workflow run started (ISO 8601).
Current status of the workflow run. One of: queued, in_progress, completed, waiting, requested, pending.
Timestamp when the workflow run was last updated (ISO 8601).
Every operation an agent can call against GitHub, with input parameters and output schema. Drop these into any step of an agent built in Helix.
GITHUB_ABORT_REPOSITORY_MIGRATIONTool to abort a repository migration that is queued or in progress. Use when you need to cancel an ongoing migration operation.
Input parameters
The ID of the repository migration to abort. This is the migration ID returned when a migration was queued (e.g., 'RM_kgDOABCDEF').
A unique identifier for the client performing the mutation. This can be used to track the mutation in logs or for idempotency purposes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ACCEPT_REPOSITORY_INVITATIONAccepts a PENDING repository invitation that has been issued to the authenticated user.
Input parameters
Unique identifier of the repository invitation sent TO the authenticated user. Get this ID by listing your pending invitations using the 'List repository invitations for the authenticated user' action.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_APP_ACCESS_RESTRICTIONSAdds GitHub Apps to the list of apps allowed to push to a protected branch. The branch must already have protection rules with restrictions enabled. This endpoint only works for organization repositories, not personal repositories. Apps must be installed on the repository with 'contents' write permissions.
Input parameters
The list of GitHub App slugs with push access to grant. Apps must be installed on the repository and have 'contents' write permissions. The app slug is the URL-friendly name of the GitHub App (e.g., 'github-actions', 'dependabot').
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The organization name that owns the repository. This field is not case-sensitive. Note: This endpoint only works for organization-owned repositories.
The name of the branch to which restrictions will be applied. Wildcard characters (e.g., '*') are not allowed in the branch name when using this REST API endpoint. For operations involving wildcard branch names, consult the GitHub GraphQL API.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_A_REPOSITORY_COLLABORATORAdds a GitHub user as a repository collaborator, or updates their permission if already a collaborator; `permission` applies to organization-owned repositories (personal ones default to 'push' and ignore this field), and an invitation may be created or permissions updated directly.
Input parameters
The name of the repository, without the `.git` extension. This name is not case sensitive.
The account owner of the repository. This name is not case sensitive.
The GitHub handle for the user account to add as a collaborator. Cannot be the same as the repository owner, as owners are automatically collaborators.
Permission level for the collaborator. For organization-owned repositories, valid values are `pull` (read-only), `triage` (manage issues/PRs), `push` (read/write), `maintain` (manage most settings), `admin` (full control), or a custom repository role name if defined by the owning organization. This parameter is ignored for personal repositories, which grant `push` access.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_ASSIGNEES_TO_AN_ISSUEAdds assignees to a GitHub issue. This action only adds users - it does not remove existing assignees. Changes are silently ignored if the authenticated user lacks push access to the repository.
Input parameters
The name of the repository, without the `.git` extension. This field is not case sensitive.
The username of the account or the organization name that owns the repository. This field is not case sensitive.
A list of GitHub usernames to add as assignees to the issue. Up to 10 assignees total can be on an issue. NOTE: This endpoint ADDS assignees - it does not replace existing ones. Users already assigned are kept. To remove assignees, use the 'remove_assignees_from_an_issue' action instead. The authenticated user must have push access to the repository; otherwise changes are silently ignored.
The unique number identifying the issue within the repository. Must be a positive integer (GitHub issue numbers start at 1).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_EMAIL_ADDRESS_FOR_AUTHENTICATED_USERAdds one or more email addresses (which will be initially unverified) to the authenticated user's GitHub account; use this to associate new emails, noting an email verified for another account will error, while an existing email for the current user is accepted.
Input parameters
Array of email addresses to add to the authenticated user account. Must contain at least one email address.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_FIELD_TO_USER_PROJECTTool to add a custom field to a user-owned GitHub Projects V2 project. Use when you need to add fields like status, priority, or custom data to organize project items.
Input parameters
The name of the field to create.
The handle for the GitHub user account.
The data type of the field. Use 'single_select' for dropdown fields, 'iteration' for sprint fields, or other types for simple fields.
The project's number.
Options for single select fields. Required when data_type is 'single_select'.
Configuration for iteration fields.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_ITEM_TO_USER_PROJECTTool to add an issue or pull request to a user-owned GitHub project. Use when you need to add existing repository items to a project board.
Input parameters
The unique identifier of the issue or pull request to add to the project. Required if owner, repo, and number are not provided.
The repository name. Required with owner and number if id is not provided.
The type of item to add to the project. Must be either Issue or PullRequest.
The repository owner login. Required with repo and number if id is not provided.
The issue or pull request number. Required with owner and repo if id is not provided.
The handle for the GitHub user account.
The project's number.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_LABELS_TO_AN_ISSUEAdds labels (provided in the request body) to a repository issue; labels that do not already exist are created.
Input parameters
Repository name, without the `.git` extension (case-insensitive).
Username or organization name owning the repository (case-insensitive).
Array of label names to add to the issue. Labels that don't exist will be created automatically.
Positive integer that uniquely identifies the issue within the repository. Must be >= 1.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_ORG_RUNNER_LABELSAdds new custom labels to an existing self-hosted runner for an organization; existing labels are not removed, and duplicates are not added.
Input parameters
The organization's name (case-insensitive).
A list of custom label names to add to the self-hosted runner. Previously applied labels are not removed.
Unique identifier of the self-hosted runner.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_OR_UPDATE_TEAM_MEMBERSHIP_FOR_USERAdds a GitHub user to a team or updates their role (member or maintainer), inviting them to the organization if not already a member; idempotent, returning current details if no change is made.
Input parameters
The name of the GitHub organization. This name is not case-sensitive.
The role to assign to the user within the team. A 'maintainer' has broader permissions than a 'member', such as managing team members and settings.
The GitHub username of the user to add or whose membership to update.
The slug (URL-friendly version) of the team's name. Must be lowercase with hyphens instead of spaces (e.g., 'my-team' not 'My Team'). Spaces will be automatically converted to hyphens and text will be lowercased.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_OR_UPDATE_TEAM_PROJECT_PERMISSIONSAdds a classic project to a team or updates the team's permission on it. This endpoint grants or updates permissions for a team on a specific classic project (not Projects V2). The authenticated user must have admin permissions for the project. Both the team and project must belong to the same organization. Requirements: - The project must be a classic project (not GitHub Projects V2) - The authenticated user must have admin permissions on the project - The team and project must be in the same organization - Requires 'admin:org' scope for the authentication token Returns HTTP 204 No Content on success, 403 if project is not an org project, or 404 if the organization, team, or project is not found.
Input parameters
The organization name (login) that owns both the team and the classic project. Case-insensitive.
The team's URL-friendly slug identifier within the organization. Found in the team's URL path.
Permission level to grant the team: 'read' (view only), 'write' (view and edit), or 'admin' (full control including settings). If omitted, uses the team's default permission.
The unique numeric ID of the classic project. This is NOT the project number displayed in the UI.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_OR_UPDATE_TEAM_REPOSITORY_PERMISSIONSSets or updates a team's permission level for a repository within an organization; the team must be a member of the organization.
Input parameters
Organization name where the team exists (case-insensitive). This is the organization that owns the team, not necessarily the repository owner.
Repository name, without the `.git` extension (case-insensitive).
Account owner of the repository (case-insensitive). This is the user or organization that owns the repository. In most cases, this should match the 'org' parameter value.
The team's slug (URL-friendly name).
Permission level to grant the team. Valid values: 'pull' (read-only), 'triage' (manage issues/PRs), 'push' (read/write), 'maintain' (manage repo settings plus push), 'admin' (full control). Custom repository role names are also supported if defined by the organization.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_PROJECT_COLLABORATORAdds a specified GitHub user as a collaborator to an existing organization project with a given permission level. Note: This endpoint is for organization projects (classic). You must be an organization owner or a project admin to add a collaborator. Classic projects are being deprecated in favor of the new Projects experience.
Input parameters
The GitHub username of the user to be added as a collaborator.
Permission level for the collaborator on the project.
The unique identifier of the organization project.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_REPOSITORY_TO_APP_INSTALLATIONAdds a repository to a GitHub App installation, granting the app access; requires authenticated user to have admin rights for the repository and access to the installation.
Input parameters
The unique identifier of the repository to add to the installation. The authenticated user must have admin permissions for this repository.
The unique identifier of the GitHub App installation to which the repository will be added. This installation must be accessible to the authenticated user.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_REPO_TO_ORG_SECRET_WITH_SELECTED_ACCESSAdds a repository to an existing organization-level GitHub Actions secret that is configured for 'selected' repository access.
Input parameters
The name of the GitHub organization. This field is not case-sensitive.
The name of the organization secret to which the repository will be added.
The unique identifier of the repository to be granted access to the organization secret.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_REPO_TO_ORG_SECRET_WITH_SELECTED_VISIBILITYGrants an existing repository access to an existing organization-level Dependabot secret when the secret's visibility is set to 'selected'; the repository must belong to the organization, and the call succeeds without change if access already exists.
Input parameters
The organization's unique handle/name (case-insensitive).
Name of the Dependabot secret; must be alphanumeric or underscore, no spaces (lowercase auto-converts to uppercase).
Unique ID of the repository to be granted access to the secret.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_RUNNER_LABELSAdds and appends custom labels to a self-hosted repository runner, which must be registered and active.
Input parameters
Name of the repository, without the `.git` extension. Case-insensitive.
Username or organization name of the repository owner. Case-insensitive.
Custom label names to add. Appended to existing labels. Names are case-insensitive. Empty list means no changes.
Unique ID of the self-hosted runner.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_SELECTED_REPOSITORY_TO_ORGANIZATION_SECRETAdds a repository to an organization secret's access list when the secret's visibility is 'selected'; this operation is idempotent.
Input parameters
The name of the organization. This name is not case sensitive.
The name of the secret. Secret names can only contain alphanumeric characters (\[A-Z\], \[a-z\], \[0-9\]) or underscores (_). Spaces are not allowed. Secret names cannot start with GITHUB_ and must be less than 255 characters.
The unique identifier of the repository to add to the secret's access list.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_SELECTED_REPOSITORY_TO_ORGANIZATION_VARIABLEGrants a repository access to an organization-level GitHub Actions variable, if that variable's visibility is set to 'selected_repositories'.
Input parameters
Name of the GitHub organization (case-insensitive).
Name of the existing organization-level GitHub Actions variable.
Unique identifier of the repository to grant access.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_SELECTED_REPOSITORY_TO_USER_SECRETGrants a specified repository access to an authenticated user's existing Codespaces secret, enabling Codespaces created for that repository to use the secret.
Input parameters
Name of the user-level Codespaces secret to which repository access is added; this secret must already exist for the authenticated user.
The unique identifier of the repository to be granted access to the specified user-level Codespaces secret.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_SOCIAL_ACCOUNTS_FOR_AUTHENTICATED_USERAdds one or more social media links (which must be valid, full URLs for platforms supported by GitHub) to the authenticated user's public GitHub profile.
Input parameters
Full URLs for social media profiles to add to the user's GitHub profile; these will be displayed publicly.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_STATUS_CHECK_CONTEXTSAdds status check contexts to a protected branch's required status checks. This action appends new status check contexts to the existing list of required status checks for a protected branch. The branch must already have branch protection enabled with status checks configured. Note: The 'contexts' parameter is deprecated by GitHub in favor of 'checks' array. For new implementations, consider using update_status_check_protection with the 'checks' parameter instead.
Input parameters
The name of the repository, without the `.git` extension. This name is not case sensitive.
The account owner of the repository. This name is not case sensitive.
The name of the branch to which status check contexts will be added. Branch names cannot contain wildcard characters. To use wildcard characters in branch names, refer to the GraphQL API.
The status check contexts to add to the protected branch. These are the names of CI/CD jobs or other checks that must pass before merging. Can be provided as a single string or a list of strings. Examples: 'ci/test', 'linter', 'continuous-integration/travis-ci'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_SUB_ISSUETool to add a sub-issue to a parent GitHub issue using GraphQL. Use when you need to establish a parent-child relationship between issues. Requires the 'sub_issues' GraphQL feature to be enabled.
Input parameters
The global node ID of the parent issue (e.g., 'I_kwDOABCDEFGH'). This is the GraphQL global identifier returned by GitHub's API.
The global node ID of the sub-issue to link to the parent issue. Either sub_issue_id or sub_issue_url must be provided.
The URL of the sub-issue to link to the parent issue. Either sub_issue_id or sub_issue_url must be provided.
If true, replaces the existing parent issue if the sub-issue already has one. If false or omitted, the mutation will fail if the sub-issue already has a parent.
A unique identifier for the client performing the mutation. Used to ensure idempotency of mutations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_TEAM_ACCESS_RESTRICTIONSAdds teams to the list of teams with push access to a protected branch. This action grants additional teams push access to a protected branch. Unlike 'Set team access restrictions' (PUT), this action adds to the existing list rather than replacing it entirely. Prerequisites: - The repository must be owned by an organization (not a personal account) - The branch must have protection rules enabled - The branch protection must have restrictions configured - The teams must exist in the organization and have repository access
Input parameters
The name of the repository, without the `.git` extension. This value is not case-sensitive.
The organization name that owns the repository. Team access restrictions only work for organization-owned repositories, not personal repositories. This value is not case-sensitive.
The list of team slugs to add push access to the protected branch. A team slug is the URL-friendly version of the team name (lowercase, hyphens instead of spaces). The teams must already have access to the repository. This adds teams to the existing list (does not replace the entire list).
The name of the protected branch to add team restrictions to. The branch must already have branch protection enabled with restrictions configured. Wildcard characters are not supported. For wildcard branch protection, use the GitHub GraphQL API.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_USER_ACCESS_RESTRICTIONSAdds users to the list of people allowed to push to a protected branch in an organization repository. Important notes: - This action only works on organization-owned repositories (not personal repos) - The branch must already have protection rules with restrictions enabled - Users must have write access to the repository to be added - The combined total of users, apps, and teams is limited to 100 items
Input parameters
The name of the repository, without the `.git` extension. This name is not case-sensitive.
The account owner of the repository (must be an organization for user restrictions). This name is not case-sensitive.
The list of user logins to grant push access to the protected branch. Users must have write access to the repository. An empty list will remove all user restrictions.
The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, refer to the GitHub GraphQL API documentation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ADD_USERS_TO_CODESPACES_ACCESS_FOR_ORGANIZATIONAdds organization members to the list of users granted Codespaces access billed to the organization. IMPORTANT: This endpoint requires the organization's Codespaces billing access to be set to 'selected_members' mode. If not already configured, use the GITHUB_MANAGE_ACCESS_CONTROL_FOR_ORGANIZATION_CODESPACES action first to set visibility to 'selected_members'.
Input parameters
Organization's name (case-insensitive).
Usernames of organization members to be granted Codespaces access billed to the organization. These users must be members of the specified organization.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_API_ROOTRetrieves a map of all top-level GitHub REST API resource URLs and their templates.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_APPROVE_WORKFLOW_RUN_FOR_FORK_PULL_REQUESTApproves a workflow run from a forked repository's pull request; call this when such a run requires manual approval due to workflow configuration.
Input parameters
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
The unique identifier of the workflow run requiring approval.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ASSIGN_ORGANIZATION_ROLE_TO_TEAMAssigns an existing organization-level role (identified by `role_id`) to a team (identified by `team_slug`) within a GitHub organization (`org`), provided the organization, team, and role already exist.
Input parameters
The name of the GitHub organization. This field is case-insensitive.
Unique identifier of the organization role to assign to the team (obtainable by listing organization roles).
The slug (URL-friendly version) of the team's name.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ASSIGN_ORGANIZATION_ROLE_TO_USERAssigns a specific organization role to a user who is a member or an outside collaborator in a GitHub organization, using a valid role ID.
Input parameters
The organization's name. This is not case-sensitive.
The unique integer identifier for the organization role. This ID can be obtained by listing the organization's roles.
The GitHub username of the user to whom the role will be assigned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_AUTH_USER_DOCKER_CONFLICT_PACKAGES_LISTList Docker packages with migration conflicts for the authenticated user. This endpoint lists all Docker packages owned by the authenticated user that encountered namespace conflicts during the Docker-to-GitHub Container Registry (GHCR) migration. Conflicts occur when a package with the same name exists in both the legacy Docker registry and GHCR. IMPORTANT: The Docker registry for GitHub Packages was deprecated on Feb 24, 2025. This endpoint may return a 400 error with message 'Package migration for docker is no longer supported' as the migration period has ended. In this case, the action returns an informative response instead of failing. Use case: Identifying packages that require manual migration to GHCR. Required scope: read:packages (for OAuth and personal access tokens).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_BLOCK_USERBlocks an existing individual GitHub user (not an organization or your own account), preventing them from interacting with your account and repositories.
Input parameters
The GitHub username (handle) of the user to block. Case-insensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_BLOCK_USER_FROM_ORGANIZATIONBlocks a GitHub user from an organization, preventing their contributions, collaboration, and forking of the organization's repositories. Requires admin or 'Blocking users' organization permission (write access).
Input parameters
The organization name (case-insensitive). You must have admin or 'Blocking users' permission in this organization.
The GitHub username (handle) of the account to block from the organization.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CANCEL_GITHUB_PAGES_DEPLOYMENTCancels an existing, ongoing or queued GitHub Pages deployment for a repository using its `pages_deployment_id`.
Input parameters
Repository name, excluding the `.git` extension. Not case-sensitive.
Username or organization that owns the repository. Not case-sensitive.
Unique numerical ID of the GitHub Pages deployment (not the commit SHA).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CANCEL_SPONSORSHIPTool to cancel an active GitHub sponsorship using GraphQL. Use when you need to terminate a sponsorship relationship between a sponsor and a sponsorable entity. Either sponsor ID/login and sponsorable ID/login must be provided.
Input parameters
The global node ID of the user or organization acting as sponsor (e.g., 'U_kgDOABCDEF'). Required if sponsor_login is not provided.
The username of the sponsoring user or organization. Required if sponsor_id is not provided.
The global node ID of the user or organization receiving the sponsorship (e.g., 'U_kgDOMNOPQR'). Required if sponsorable_login is not provided.
The username of the sponsored user or organization. Required if sponsorable_id is not provided.
A unique identifier for the client performing the mutation. Used to ensure idempotency of mutations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CANCEL_WORKFLOW_RUNCancels a workflow run in a GitHub repository if it is in a cancellable state (e.g., 'in_progress' or 'queued'). Returns 202 Accepted on success.
Input parameters
The name of the repository, without the `.git` extension (not case-sensitive).
The account owner of the repository (not case-sensitive).
Unique identifier of the workflow run.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CHECK_IF_GIST_IS_STARREDChecks if a gist is starred by the authenticated user. Returns `is_starred: true` if the gist is starred (HTTP 204), or `is_starred: false` if not starred (HTTP 404). Use this to verify star status before starring/unstarring a gist.
Input parameters
The unique identifier (ID) of the gist to check. Can be found in the URL of the gist (e.g., 'https://gist.github.com/{user}/{gist_id}').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CHECK_IF_PULL_REQUEST_HAS_BEEN_MERGEDChecks if a specified GitHub pull request has been merged, indicated by a 204 HTTP status (merged) or 404 (not merged/found).
Input parameters
The name of the repository, without the `.git` extension (not case sensitive).
The account owner of the repository (not case sensitive).
The number that identifies the pull request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CHECK_IF_USER_CAN_BE_ASSIGNEDVerifies if a GitHub user can be assigned to issues in a repository; assignability is confirmed by an HTTP 204 (No Content) response, resulting in an empty 'data' field in the response.
Input parameters
The name of the repository, without the `.git` extension. This name is not case sensitive.
The account owner of the repository (e.g., a GitHub username or organization name). This name is not case sensitive.
The GitHub username of the user to check for assignability. This name is not case sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CHECK_IF_USER_CAN_BE_ASSIGNED_TO_ISSUEChecks if a specified GitHub user can be assigned to a given issue within a repository.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username of the account owning the repository. This field is not case-sensitive.
The GitHub username of the user to check for assignment permissions.
The unique number identifying the issue within the repository.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CHECK_IF_USER_FOLLOWS_ANOTHER_USERChecks if a GitHub user `username` follows `target_user`; returns a 204 HTTP status if true, 404 if not or if users are invalid.
Input parameters
The GitHub username of the user to check.
The GitHub username of the user to verify if they are followed by the `username`.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CHECK_IF_USER_IS_BLOCKED_BY_AUTHENTICATED_USERChecks if the specified GitHub user is blocked by the authenticated user; a 204 No Content response indicates the user is blocked, while a 404 Not Found indicates they are not.
Input parameters
The GitHub username (handle) of the user.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CHECK_IF_USER_IS_BLOCKED_BY_ORGANIZATIONChecks if a GitHub user is blocked by an organization. Returns is_blocked=True if the user is blocked (HTTP 204), or is_blocked=False if not blocked (HTTP 404). Requires 'Blocking users' organization permission (read access).
Input parameters
The organization name (case-insensitive). Must be an organization where you have 'Blocking users' permission (read access).
The GitHub username (handle) to check if blocked by the organization.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CHECK_IF_USER_IS_REPOSITORY_COLLABORATORChecks if a user is a collaborator on a specified GitHub repository, returning a 204 status if they are, or a 404 status if they are not or if the repository/user does not exist.
Input parameters
The name of the repository, without the `.git` extension. This name is not case sensitive.
The account owner of the repository, typically a GitHub username or an organization name. This name is not case sensitive.
The GitHub username of the user whose collaborator status is being checked. This name is not case sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CHECK_PERSON_FOLLOWED_BY_AUTH_USERChecks if the authenticated GitHub user follows a target GitHub user. Returns a structured response with is_following=True when following (HTTP 204), or is_following=False when not following (HTTP 404).
Input parameters
The GitHub username (e.g., 'octocat') of the person to check. This is the user's handle on GitHub.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CHECK_PRIVATE_VULNERABILITY_REPORTING_STATUSChecks if private vulnerability reporting is enabled for the specified repository.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CHECK_PUBLIC_ORGANIZATION_MEMBERSHIP_FOR_USERTool to check if a user is a public member of an organization. Use when you need to verify public organization membership status.
Input parameters
The organization name. The name is not case sensitive.
The handle for the GitHub user account.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CHECK_TEAM_PERMISSIONS_FOR_A_PROJECTChecks if a team has 'read', 'write', or 'admin' permissions for an organization's specific classic project, returning the project's details if access is confirmed.
Input parameters
The name of the organization. This is case-insensitive.
The slug (short name) of the team.
The unique identifier of the project (classic).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CHECK_TEAM_PERMISSIONS_FOR_A_REPOSITORYChecks a team's permissions for a specific repository within an organization, including permissions inherited from parent teams.
Input parameters
The name of the organization. This field is not case-sensitive.
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The organization that owns the repository. For this GitHub API endpoint, this value must be the same as the `org` parameter. This field is not case-sensitive.
The URL-friendly slug for the team name. It is unique within the organization and typically all lowercase with hyphens instead of spaces.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CHECK_TOKENChecks if a GitHub App or OAuth access_token is valid for the specified client_id and retrieves its details, typically to verify its active status and grants. NOTE: This endpoint requires Basic Authentication using the OAuth App's client_id as username and client_secret as password. The access_token parameter must be an OAuth token issued by the specified OAuth App.
Input parameters
The unique client ID of your GitHub OAuth App (must match the app that issued the token being checked).
The OAuth access token issued by your OAuth App that you want to validate. Returns 404 if the token is invalid or not issued by this client_id.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CLEAR_PROJECT_V2_ITEM_FIELD_VALUETool to clear the value of a field for an item in a GitHub Project V2. Use when you need to remove or reset a field value (text, number, date, assignees, labels, single-select, iteration, or milestone fields).
Input parameters
The global node ID of the project item to update (e.g., 'PVTI_lAHOCNqc1s4BN3oqzgldG_w'). This identifies the specific item within the project whose field value will be cleared.
The global node ID of the field to clear (e.g., 'PVTSSF_lAHOCNqc1s4BN3oqzg8vTnA'). Currently supports text, number, date, assignees, labels, single-select, iteration and milestone fields.
The global node ID of the Project (e.g., 'PVT_kwHOCNqc1s4BN3oq'). This identifies the project containing the item.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CLEAR_REPOSITORY_CACHE_BY_KEYDeletes GitHub Actions caches from a repository matching a specific `key` and an optional Git `ref`, used to manage storage or clear outdated/corrupted caches; the action succeeds even if no matching caches are found to delete.
Input parameters
The exact cache key used to identify specific caches for deletion. This key is often dynamically generated in workflows using expressions (e.g., `${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}`).
The full Git reference for narrowing down the cache deletion. For example, to target caches for a specific branch, use `refs/heads/<branch_name>`. To target caches for a pull request, use `refs/pull/<pull_number>/merge`. If omitted, caches matching the key across all refs are considered.
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CLEAR_SELF_HOSTED_RUNNER_ORG_LABELSRemoves all custom labels from a self-hosted runner for an organization; default labels (e.g., 'self-hosted', 'linux', 'x64') will remain.
Input parameters
The name of the GitHub organization that owns the self-hosted runner (case-insensitive).
Unique numeric identifier of the self-hosted runner. Can be obtained from listing runners for the organization.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_COMMIT_MULTIPLE_FILESTool to atomically create, update, or delete multiple files in a GitHub repository as a single commit. Uses Git Data APIs to avoid SHA mismatch conflicts that occur with the Contents API when multiple files are modified in parallel. Use when you need to make multi-file changes reliably. BRANCH CREATION: When committing to a new branch (e.g., 'fix/my-fix' or 'feature/new-feature'), you MUST provide 'base_branch' (typically 'main' or 'master') to create the branch from. If the branch already exists, base_branch is not needed. This action handles race conditions automatically: if the branch is updated by another commit between fetching the HEAD and updating the reference (resulting in a 422 'not a fast forward' error), the action will retry by refetching the HEAD and rebasing changes. Use max_retries to control this behavior.
Input parameters
Repository name (without .git extension)
Force update the branch reference. WARNING: Use with caution as this can overwrite commits. Only use this when you intentionally want to overwrite the branch history.
Repository owner (username or organization name)
Git author or committer information.
Target branch name to commit to. If this branch doesn't exist, you MUST provide 'base_branch' to create it. For new feature branches (e.g., 'fix/my-fix', 'feature/new-feature'), always set base_branch='main' (or your default branch).
List of file paths to delete from the repository. Files must exist in the repository; attempting to delete non-existent files will result in an error. Ensure paths are exact with no leading/trailing whitespace.
Commit message describing the changes
List of files to create or update. Each entry requires path, content, and optional encoding (utf-8 or base64)
Git author or committer information.
REQUIRED when committing to a new branch that doesn't exist yet. Specifies the existing branch to create the new branch from (e.g., 'main' or 'master'). Not needed if 'branch' already exists in the repository.
Maximum number of retries when encountering race conditions (422 'not a fast forward' errors). The action will refetch the HEAD and rebase changes on each retry. Set to 0 to disable retries.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_COMPARE_TWO_COMMITSCompares two commit points (commits, branches, tags, or SHAs) within a repository or across forks, using `BASE...HEAD` or `OWNER:REF...OWNER:REF` format for the `basehead` parameter.
Input parameters
Page number of the results to fetch, for pagination when the number of differences (commits or files) is large.
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
A string specifying the base and head references to compare, in the format `BASE...HEAD`. `BASE` and `HEAD` can be branch names (e.g., `main...develop`), tag names (e.g., `v1.0.0...v1.1.0`), or commit SHAs (abbreviated or full 40-character format). Both abbreviated and full SHAs are accepted; full 40-character SHAs are recommended for reliability in large repositories. Both references must exist in the specified repository. To compare branches across forks in the same network, use the format `OWNER:REF...OWNER:REF` (e.g., `octocat:main...another-user:main`). Do NOT pass GitHub URLs - only plain reference strings like 'main...develop' are accepted.
Number of results (e.g., files or commits) to return per page, with a maximum of 100, for pagination.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CONFIGURE_JIT_RUNNER_FOR_ORGGenerates a JIT configuration for a GitHub organization's new self-hosted runner to run a single job then unregister; requires admin:org scope and the runner_group_id must exist in the organization.
Input parameters
Name of the GitHub organization (case-insensitive).
Desired name for the new self-hosted runner, visible in the GitHub UI.
Custom labels to assign to the new self-hosted runner, used by GitHub Actions to route jobs. **Minimum items**: 1. **Maximum items**: 100.
Path to the working directory on the runner machine where jobs will execute, relative to the runner's installation directory.
ID of the runner group to assign the new self-hosted runner. Must exist in the organization. You can get runner group IDs by calling the 'List self-hosted runner groups for an organization' endpoint (GET /orgs/{org}/actions/runner-groups).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CONFIGURE_OIDC_SUBJECT_CLAIM_TEMPLATESets or updates the OIDC subject claim customization template for an existing GitHub organization by specifying which claims (e.g., 'repo', 'actor') form the OIDC token's subject (`sub`). This action customizes which claim keys are included in the OIDC subject claim for the specified organization. It allows for fine-tuning the content of the subject claim based on organizational needs.
Input parameters
The GitHub organization name (case-insensitive).
Array of unique strings, each a valid claim key (e.g., 'repo', 'actor'; alphanumeric/underscores only), to include in the OIDC subject claim (`sub`).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CONVERT_ORG_MEMBER_TO_OUTSIDE_COLLABORATORConverts an existing organization member, who is not an owner, to an outside collaborator, restricting their access to explicitly granted repositories.
Input parameters
The organization name (case-insensitive).
If true, performs the conversion asynchronously (API returns a 202 status when the job is successfully queued).
The GitHub username of the member to convert.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_BLOBCreates a Git blob in a repository, requiring content and encoding ('utf-8' or 'base64'). Requires write access to the repository.
Input parameters
The name of the repository, without the '.git' extension. This field is not case-sensitive. The repository must exist and you must have write access to it.
The username or organization name that owns the repository. This field is not case-sensitive. You must have write access to the repository.
The content to be stored in the new blob.
The encoding for the 'content'; "utf-8" or "base64".
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_CHECK_RUNCreates a new check run for a specific commit in a repository, used by external services to report status, detailed feedback, annotations, and images directly within the GitHub UI. NOTE: This endpoint requires GitHub App authentication - OAuth tokens and personal access tokens cannot create check runs.
Input parameters
The name of the check to be displayed in the GitHub UI. For example, "Code Coverage" or "Linter".
The name of the repository, without the `.git` extension. This name is not case sensitive.
The account owner of the repository. This name is not case sensitive.
The current status of the check run. Only GitHub Actions can set `status` to `waiting`, `pending`, or `requested`.
A list of up to three action objects defining interactive buttons displayed on GitHub after the check run completes. Each object needs a `label` (button text), `identifier` (unique ID for the action), and `description` (tooltip). Clicking a button sends a `check_run.requested_action` webhook to your app.
The SHA of the commit for which the check run is created.
**Required if `completed_at` is provided or if `status` is `completed`**. Specifies the final outcome of the check (e.g., 'success', 'failure'). Note: Setting `conclusion` automatically sets `status` to `completed`. GitHub alone can set a conclusion to `stale`.
The ISO 8601 timestamp (YYYY-MM-DDTHH:MM:SSZ) indicating when the check run began.
The URL of the integrator's site providing full details of the check. If omitted, the GitHub App's homepage is used. This URL is available from the check's UI.
A unique identifier for the check run on the integrator's system. This helps in correlating check runs between GitHub and the external system.
The ISO 8601 timestamp (YYYY-MM-DDTHH:MM:SSZ) indicating when the check run finished. **Required if `status` is `completed`**.
Detailed textual information about the check run's output. Supports Markdown. **Maximum length**: 65,535 characters.
A descriptive title for the output of the check run, displayed in the GitHub UI. For example, 'Linter Scan Summary'.
A list of image objects to display in the check run's output in the GitHub UI. Each object requires `alt` (alternative text), `image_url` (URL of the image), and an optional `caption`.
A summary of the check run's findings. Supports Markdown. **Maximum length**: 65,535 characters.
A list of annotation objects detailing issues at specific code locations. Annotations are visible in the 'Checks' and 'Files changed' tabs of a pull request. Each annotation object should specify `path`, `start_line`, `end_line`, `annotation_level` ('notice', 'warning', or 'failure'), and `message`. Optional fields include `start_column`, `end_column`, `title`, and `raw_details`. Up to 50 annotations per API request; for more, use subsequent 'Update a check run' calls. GitHub Actions limits are 10 warnings and 10 errors per step.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_CHECK_SUITECreates a new check suite for a specific commit (`head_sha`) in an original repository (not a fork). IMPORTANT: This endpoint requires a GitHub App installation access token - OAuth tokens and classic personal access tokens cannot use this endpoint. GitHub dispatches a `check_suite` webhook event with the `requested` action upon success.
Input parameters
Repository name, without the `.git` extension (case-insensitive).
Account owner of the repository (case-insensitive).
SHA of the commit for which to create the check suite, typically the head commit of a branch.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_CODESPACE_FOR_THE_AUTHENTICATED_USERCreates a GitHub Codespace for the authenticated user, requiring a JSON request body with either `repository_id` (integer) or a `pull_request` object (containing `pull_request_number` (integer) and `repository_id` (integer)). This action allows users to set up a development environment quickly by creating a codespace from a specified repository or pull request.
Input parameters
Git ref (branch, tag, or commit SHA) to use for the codespace.
ID of the repository to create the codespace from.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_CODESPACE_FROM_A_PULL_REQUESTCreates a GitHub Codespace for an open pull request in a Codespaces-enabled repository, with options to customize its configuration.
Input parameters
Geographic area for this codespace (e.g., `UsEast`, `EuropeWest`); supersedes `location`. If unspecified, typically IP-derived.
The name of the repository, without the `.git` extension. This is case-insensitive.
The username of the account that owns the repository. This is case-insensitive.
Machine type for this codespace (e.g., `standardLinux`). Varies by CPU, RAM, storage. Uses default if unspecified.
Requested geographic location (e.g., `EastUs`, `WestEurope`). This parameter is deprecated; use `geo`. If unspecified, location may be IP-derived.
Client's public IP address for location auto-detection if proxied and `geo` or `location` are not specified.
The unique number identifying the pull request.
Custom name for the codespace.
Path to a `devcontainer.json` file in the repository that defines the development environment.
Working directory for the codespace upon opening. Defaults to the repository root if unspecified.
Minutes of inactivity after which the codespace is automatically stopped. A default timeout applies if unspecified.
Retention period in minutes (0-43200, i.e., up to 30 days) for a stopped codespace. 0 means immediate deletion.
Set to `true` to prevent GitHub from requesting additional repository permissions defined in `devcontainer.json`. Defaults to `false` (permissions will be requested).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_CODESPACE_IN_A_REPOSITORYCreates a GitHub Codespace for the authenticated user in a specified repository, which must be accessible and use a valid `devcontainer.json` if `devcontainer_path` is specified.
Input parameters
Geographic area for the codespace, replacing `location`; determined by user IP if not specified.
Git reference (e.g., branch name) for the codespace; uses repository's default branch if not provided.
Name of the repository, without the `.git` extension; not case-sensitive.
Username or organization name owning the repository; not case-sensitive.
Machine type (CPU, RAM, storage). See 'List available machine types for a repository' action for options; uses a default type if not specified.
Requested AWS region (best-effort, may differ); determined by user IP if not provided. Deprecated: use `geo`.
IP address to infer preferred region if `location` and `geo` are unspecified; useful for proxied requests.
Custom display name for the codespace; a default name is generated if not provided.
Path to a `devcontainer.json` in the repository; uses `.devcontainer/devcontainer.json` or `devcontainer.json` at root if not specified.
Directory to use as default when codespace opens; uses repository root if not specified.
Minutes of inactivity before codespace auto-stops; uses a default timeout if not specified.
Minutes an idle (stopped) codespace is retained before auto-deletion (0-43200, i.e., up to 30 days); uses a default period if not specified.
If `true`, opts out of granting multi-repository permissions from `devcontainer.json`. If unspecified or `false`, permissions are granted if requested.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_COMMITCreates a new commit in a GitHub repository; the `tree` SHA and any `parents` SHAs must already exist in the repository.
Input parameters
Name of the repository, without the `.git` extension (case-insensitive).
SHA of the tree object for this commit; must exist in the repository.
Account owner of the repository (case-insensitive).
The commit message.
SHAs of parent commits; all must exist in the repository. Omit or provide an empty list for a root commit.
ASCII-armored detached PGP signature over the commit data. GitHub adds this to the `gpgsig` header if provided.
Timestamp (ISO 8601: `YYYY-MM-DDTHH:MM:SSZ`) when the commit was authored.
Name of the commit's author. Defaults to authenticated user if not provided.
Email of the commit's author. Defaults to authenticated user if not provided.
Timestamp (ISO 8601: `YYYY-MM-DDTHH:MM:SSZ`) when the commit was committed. Defaults to `author_date` or current time.
Name of the committer. Defaults to author's name or authenticated user if not provided.
Email of the committer. Defaults to author's email or authenticated user if not provided.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_COMMIT_COMMENTCreates a comment on a specific commit, or on a specific line if `path` and `position` are provided.
Input parameters
The text content of the comment.
**Deprecated:** Use `position` instead. Line number in the file to comment on. `position` takes precedence if both are provided.
Relative path of the file to comment on. If specified, `position` is also required.
The name of the repository, without the `.git` extension.
The username or organization name that owns the repository.
Line number in the diff's patch to comment on, relative to the commit's changes. Required if `path` is specified.
The SHA identifier of the commit to comment on.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_COMMIT_STATUSSets a commit's status (e.g., error, failure, pending, success from CI/CD) for a given SHA; max 1000 statuses per SHA/context.
Input parameters
SHA hash of the commit.
Repository name, without the `.git` extension (case-insensitive).
Username or organization name of the repository owner (case-insensitive).
State of the commit status, indicating check outcome or phase.
Label to differentiate this status from other systems (e.g., 'ci/jenkins'); case-insensitive.
URL linking to the source of the status (e.g., CI build log), displayed in GitHub UI.
Human-readable description of the status, displayed in GitHub UI.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_CUSTOM_ORGANIZATION_ROLECreates a custom role with defined permissions within a GitHub organization.
Input parameters
Name of the GitHub organization (case-insensitive) where the custom role will be created.
Unique name for the custom role.
Optional short description of the custom role's purpose or permissions.
List of fine-grained permission strings defining actions granted by this role. Use the List Organization Fine-Grained Permissions action to get available permissions for your organization.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_DEPLOY_KEYCreates a deploy key for a repository; the repository must exist and be accessible, and the provided key must be a valid public SSH key.
Input parameters
The full public SSH key. Ensure this is the public key, not the private key.
The name of the repository, without the `.git` extension. This is not case sensitive.
The username of the account that owns the repository. This is not case sensitive.
A descriptive name for the new deploy key. If not provided, a default name will be generated.
If `true`, the deploy key will only have read access. If `false` (default), the key will have read and write access. Write access grants significant privileges.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_DEPLOYMENTCreates a GitHub deployment for an existing repository, targeting a specific ref (branch, tag, or SHA) that must also exist within the repository.
Input parameters
The ref to deploy. This can be a branch name, a tag name, or a commit SHA.
The name of the repository, without the `.git` extension. This name is not case-sensitive. The repository must exist and the authenticated user must have write access to it.
Specifies a task to execute, e.g., `deploy` or `deploy:migrations`.
The account owner of the repository. This name is not case-sensitive. The repository must exist and the authenticated user must have access to it.
A JSON string payload providing additional information that a deployment system might need, customizable based on the deployment process.
Attempts to automatically merge the default branch into the requested ref if the ref is behind the default branch. Set to `false` to disable.
A short description of the deployment. Maximum length of 1000 characters.
Name for the target deployment environment (e.g., `production`, `staging`, `qa`).
A list of status check contexts to verify against commit status checks before creating the deployment. If omitted or `null`, GitHub verifies all unique contexts. Pass an empty list `\[\]` to bypass all checks.
Specifies if the given environment is specific to this deployment and will no longer exist at some point in the future (e.g., a staging environment for a pull request). Set to `true` if the environment is temporary.
Specifies if the given environment is one that end-users directly interact with.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_DEPLOYMENT_BRANCH_POLICYCreates a deployment branch or tag policy for an existing environment in a GitHub repository, using a Ruby File.fnmatch pattern (where `*` doesn't match `/`) to specify which branches or tags are deployable.
Input parameters
Name pattern for deployable branches/tags (Ruby File.fnmatch syntax; `*` won't match `/`, e.g., `release/*/*` for `release/feature/login`). Refer to \[Ruby File.fnmatch documentation\](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).
Name of the repository, without the `.git` extension (not case sensitive).
Whether the policy targets a Git branch or a tag.
Account owner of the repository (not case sensitive).
Name of the target environment; URL-encode special characters (e.g., `/` as `%2F`).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_DEPLOYMENT_STATUSCreates a status for an existing deployment, updating its operational state, associated URLs, and description.
Input parameters
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
State of the status. Setting a transient deployment to `inactive` shows it as `destroyed` in GitHub.
URL for deployment output. Preferred over `target_url`; setting this also sets `target_url` to the same value.
URL for deployment status updates or output. `log_url` is generally preferred.
Short description of the status (max 140 characters).
Name for the target deployment environment (e.g., `production`, `staging`). If unset, uses environment from previous status or deployment.
If true, sets prior successful, non-transient, non-production deployments in the same repository and environment to `inactive`.
The unique identifier of the deployment for which to create a status.
URL for accessing the target deployment environment.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_DISCUSSIONCreates a new discussion post on a specific team's page within an organization.
Input parameters
Name of the organization (not case-sensitive).
Main content of the discussion post, typically in markdown.
Title of the discussion post.
If `true`, post is private (visible only to team members, org owners, and team maintainers); `false` makes it public to all organization members.
URL-friendly version of the team name (slug).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_DISCUSSION_COMMENTCreates a new comment on an existing team discussion within a GitHub organization.
Input parameters
The name of the organization. This name is not case-sensitive.
The content of the discussion comment. Supports GitHub Flavored Markdown.
The slug (URL-friendly version) of the team name.
The unique number identifying the discussion within the team.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_FORKCreates a fork of an accessible repository, optionally into a specific organization, with a new name, or copying only the default branch.
Input parameters
The desired name for the newly created fork. If not provided, the new fork will have the same name as the original repository.
The name of the repository, without the `.git` extension. This field is not case sensitive.
The username or organization name that owns the repository. This field is not case sensitive.
The GitHub organization name to fork the repository into. If not specified, the fork will be created in the authenticated user's account.
Specifies whether to fork only the default branch of the repository. If `True`, only the default branch is copied. If `False` or not specified, all branches are copied.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_GISTCreates a new gist on GitHub with provided files, an optional description, and public/secret visibility.
Input parameters
JSON string representing content for the gist's files. Dictionary where keys are filenames and values are objects, each having a `content` key with the file's raw string data.
Indicates if the gist is public (`true`) or secret (`false`).
Optional description for the gist.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_GIST_COMMENTCreates a new comment on a specified GitHub gist.
Input parameters
The text of the comment to be posted on the gist.
The unique identifier of the gist.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_GITHUB_APP_FROM_A_MANIFESTUse this action to complete the GitHub App Manifest flow (step 3 of 3) by exchanging the temporary authorization `code` for the app's full configuration, including credentials and private key. The code is provided via redirect URL after creating the app through GitHub's web interface and must be used within 1 hour.
Input parameters
The temporary authorization code provided by GitHub during the app manifest flow (received as a query parameter in the redirect URL). This single-use code must be exchanged within 1 hour of generation to retrieve the app's configuration including credentials and private key.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_GITHUB_PAGES_DEPLOYMENTCreates a GitHub Pages deployment for a repository using a specified artifact and OIDC token, provided GitHub Pages is enabled and the artifact (containing static assets) is accessible.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The account owner of the repository (e.g., a GitHub username or organization name). This field is not case-sensitive.
OIDC token from GitHub Actions for deployment authorization, typically from `secrets.GITHUB_TOKEN` with `id-token: write` permission.
Identifier of a GitHub Actions artifact (e.g., .zip or .tar) with static assets for deployment. Artifact must belong to the repository. Either this or `artifact_url` is required.
Target environment for this GitHub Pages deployment. Defaults to `github-pages`.
URL of a GitHub Actions artifact (e.g., .zip or .tar) with static assets for deployment. Artifact must belong to the repository. Either this or `artifact_id` is required.
Unique string identifying the build version for this deployment, typically the Git commit SHA. Defaults to `GITHUB_SHA`.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_GITHUB_PAGES_SITEConfigures or updates GitHub Pages for a repository, setting build type and source; ensure a Pages workflow exists for 'workflow' `build_type`, or `source_branch` exists for 'legacy' or unspecified `build_type`. This action allows users to effectively manage their GitHub Pages site settings, specifying how the site is built and where the source files are located.
Input parameters
The name of the repository, without the '.git' extension. This field is case-insensitive.
The username or organization name that owns the repository. This field is case-insensitive.
Build process for the Pages site: 'legacy' (traditional GitHub Pages build) or 'workflow' (GitHub Actions). If omitted and `source_branch` is provided, defaults to 'legacy'. When 'workflow', `source_branch` and `source_path` are ignored.
Directory within `source_branch` for site source files (e.g., '/' for root, '/docs'). Ignored if `build_type` is 'workflow'.
The branch for GitHub Pages source (e.g., 'main', 'gh-pages'). Required if `build_type` is 'legacy' or not specified. It is ignored if `build_type` is 'workflow'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_LABELCreates a new label in a specified GitHub repository, provided the repository exists and the user has write permissions.
Input parameters
The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji !\[:strawberry:\](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see the "\[Emoji cheat sheet\](https://github.com/ikatyang/emoji-cheat-sheet)."
The name of the repository, without the `.git` extension. This is not case sensitive.
The hexadecimal color code for the label (e.g., `f29513`), without the leading `#`. Required parameter.
The username of the account that owns the repository. This is not case sensitive.
A short description of the label. Maximum 100 characters.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_MILESTONECreates a milestone in a GitHub repository for tracking progress on issues or pull requests; requires repository existence and user write permissions.
Input parameters
Repository name, without the `.git` extension (case-insensitive).
Username of the repository owner (case-insensitive).
State of the milestone.
Title for the new milestone.
Due date for the milestone (ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`).
Detailed description of the milestone.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_AN_AUTOLINK_REFERENCE_FOR_A_REPOSITORYCreates a repository autolink to automatically convert text references (e.g., 'TICKET-123') into hyperlinks, using a unique `key_prefix` and a `url_template` that includes `<num>`.
Input parameters
The name of the repository, without the `.git` extension. The name is not case-sensitive.
The account owner of the repository. This can be a username or an organization name. The name is not case-sensitive.
Prefix that triggers the autolink (e.g., 'JIRA-'). When followed by an identifier, it's converted into a link. Must be non-empty and not contain spaces.
URL template for the autolink, using `<num>` as a placeholder for the reference identifier (e.g., 'https://example.atlassian.net/browse/<num>'). Behavior of `<num>` is determined by `is_alphanumeric`.
Specifies if the `<num>` placeholder in `url_template` matches alphanumeric characters (`A-Z` (case-insensitive), `0-9`, and `-`) or only numeric characters (`0-9`).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_AN_ENVIRONMENT_VARIABLECreates an encrypted environment variable for a pre-existing environment within a GitHub repository; will fail if the variable name already exists.
Input parameters
The name of the environment variable to create (e.g., `API_KEY`).
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
The value of the environment variable (e.g., `your_secret_token`). This value will be encrypted.
The name of the environment for which to create the variable. The name must be URL encoded if it contains special characters (e.g., slashes `/` must be replaced with `%2F`).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_AN_ISSUECreates a new issue in a GitHub repository, requiring the repository to exist and have issues enabled; specific fields like assignees, milestone, or labels may require push access.
Input parameters
The detailed textual contents of the new issue.
The name of the repository, without the `.git` extension (case-insensitive). The repository must exist, be accessible, and have issues enabled.
The GitHub account owner of the repository (case-insensitive). The repository must exist and be accessible to the authenticated user.
The title for the new issue.
Array of label names to associate with this issue (generally case-insensitive). NOTE: Only users with push access can set labels; they are silently dropped otherwise. Pass an empty list to clear all labels.
Login for the user to whom this issue should be assigned. NOTE: Only users with push access can set the assignee; it is silently dropped otherwise. **This field is deprecated in favor of `assignees`.**
GitHub login names for users to assign to this issue. NOTE: Only users with push access can set assignees; they are silently dropped otherwise.
The ID of the milestone to associate this issue with (e.g., "5"). NOTE: Only users with push access can set the milestone; it is silently dropped otherwise.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_AN_ISSUE_COMMENTCreates a new comment on an existing GitHub issue or pull request within the specified repository.
Input parameters
Comment content in GitHub Flavored Markdown.
Name of the repository (without `.git` extension); not case-sensitive.
Account owner of the repository (username or organization); not case-sensitive.
Number identifying the issue or pull request for the comment.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_AN_ORGANIZATION_PROJECTCreates a new classic project board within a specified GitHub organization. Note: This action uses GitHub's Projects (classic) REST API. The classic projects feature may be disabled in some organizations, and GitHub recommends migrating to Projects V2 (accessible via GraphQL API) for new projects. Requirements: - The authenticated user must be an organization member with project creation permissions - Classic projects must be enabled for the organization - Requires 'repo' and 'admin:org' or 'write:org' scopes
Input parameters
Name of the organization (not case-sensitive).
Body or description for the new project.
Name for the new project.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_AN_ORGANIZATION_REPOSITORYCreates a new repository within a specified GitHub organization, with options for detailed configuration including visibility, features, merge strategies, initial commit, and templates.
Input parameters
Name of the organization where the repository will be created (case-insensitive).
Name of the new repository.
Whether the repository is private. `visibility` takes precedence if both are set.
ID of the team to grant access to this repository within the organization.
Enable wiki for this repository.
URL for the repository's homepage.
Create an initial commit with an empty README.
Enable issues for this repository.
Repository visibility: 'public' (visible to everyone) or 'private' (visible to collaborators).
Short description of the repository.
Make this repository a template repository.
Enable projects for this repository. Fails if organization has disabled repository projects and this is true.
Enable downloads for this repository (deprecated).
Allow auto-merge on pull requests.
License template keyword (e.g., "mit", "apache-2.0"). See \[GitHub license documentation\](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) for options.
JSON string containing custom properties for the repository as a key-value object. Example: '{"project_lead": "octocat", "status": "alpha"}'
Allow merging pull requests with a merge commit.
Allow rebase-merging pull requests.
Allow squash-merging pull requests.
Name of the .gitignore template to apply (e.g., "Python", "Node"). Refer to the \[GitHub gitignore template list\](https://github.com/github/gitignore).
Default title for merge commits: 'PR_TITLE' or 'MERGE_MESSAGE'.
Default message for merge commits: 'PR_TITLE', 'PR_BODY', or 'BLANK'.
Automatically delete head branches when pull requests are merged. Requires organization owner privileges if true.
Default title for squash merge commits: 'PR_TITLE' or 'COMMIT_OR_PR_TITLE'.
Default message for squash merge commits: 'PR_BODY', 'COMMIT_MESSAGES', or 'BLANK'.
DEPRECATED: Use `squash_merge_commit_title`. Default to pull request title for squash-merge commits.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_AN_ORGANIZATION_VARIABLECreates a new, uniquely named GitHub Actions variable for an organization, with configurable repository access visibility (all, private, or selected).
Input parameters
The name of the GitHub organization. This name is not case-sensitive.
The name of the organization variable. Must be unique at the organization level.
The value of the organization variable.
Controls which repositories in the organization can access the variable. Accepted values are 'all' (all repositories), 'private' (only private repositories), or 'selected' (specific repositories designated by `selected_repository_ids`).
A list of repository integer IDs that can access this organization variable. This field is required and only applicable when `visibility` is set to 'selected'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_AN_ORGANIZATION_WEBHOOKCreates a webhook for a GitHub organization to deliver event notifications to a configured URL.
Input parameters
The name of the GitHub organization. This name is not case-sensitive.
The name of the webhook. Must be "web" for organization webhooks. Defaults to "web".
Boolean indicating if the webhook is active. `true` sends notifications, `false` does not. Defaults to `true`.
List of event names to trigger the webhook. Use `\['*'\]` for all events. Defaults to `\['push'\]` if not specified. See GitHub docs for event types.
Required. The target URL for webhook payload delivery. This URL is a mandatory part of the webhook's `config` object and will receive POST requests for subscribed events.
Optional secret for generating an HMAC hex digest for payload verification (X-Hub-Signature-256 header). If provided, this is used as the key.
Password for basic authentication if the webhook endpoint (`config_url`) requires it, corresponding to `config_username`.
Username for basic authentication if the webhook endpoint (`config_url`) requires it. Use only if your endpoint is protected by basic auth.
The media type for serializing webhook payloads. Supported: `json`, `form`. GitHub API defaults to `form` if this field is not set or is `None`.
Controls SSL certificate verification for `config_url`. '1' disables verification (not recommended), '0' enables. GitHub API defaults to '0' (verification enabled) if this field is not set or is `None`.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_PROJECT_CARDCreates a project card in a GitHub project column (classic projects only). DEPRECATION NOTICE: GitHub Projects (classic) was sunset on August 23, 2024. This API only works with existing classic project columns. New classic projects cannot be created. Consider using GitHub Projects V2 (GraphQL API) instead. The request body must contain either: - `note`: A text note for the card - OR `content_id` AND `content_type`: To associate an issue or pull request
Input parameters
The text content for the card. Use this to create a note-only card. Either 'note' OR both 'content_id' and 'content_type' must be provided.
The unique identifier of the project column where the card will be created. This value is used as a path parameter in the API request URL (e.g., `/projects/columns/{column_id}/cards`).
The unique identifier of the issue or pull request to associate with this card. Required when content_type is specified. Get this from the issue/PR details (it's the numeric ID, not the issue number).
Type of content to associate with the card.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_PROJECT_COLUMNCreates a new column in a GitHub project (classic). DEPRECATION NOTICE: GitHub Classic Projects (V1) and its REST API were sunset on April 1, 2025. This action will return a 404 error on GitHub.com. For new projects, use GitHub Projects V2 which uses the GraphQL API instead. See: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/
Input parameters
The name for the new project column.
The unique identifier of the target GitHub project (classic) where the new column will be created.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_PULL_REQUESTCreates a pull request in a GitHub repository, requiring existing `base` and `head` branches; `title` or `issue` must be provided.
Input parameters
The name of the branch you want the changes pulled into. This must be an existing branch on the current (target) repository. You cannot submit a pull request to one repository that requests a merge to a base branch of another repository.
The detailed description or contents of the pull request.
The name of the branch where your changes are implemented. IMPORTANT: This branch must already exist in the repository (or fork) before calling this action. You must first create the branch and push commits to it (using git or the 'Create a reference' action), then create the PR. For cross-repository pull requests, namespace `head` with the source owner and branch, like `username:branch`.
The name of the repository, without the `.git` extension. This name is not case-sensitive.
Indicates whether the pull request should be created as a draft. Draft pull requests cannot be merged until marked as ready for review.
The number of an existing issue in the repository to convert into a pull request. If provided, the issue's title and body may be used for the pull request. Required if `title` is not specified.
The account owner of the repository. This name is not case-sensitive.
The title of the new pull request. Required unless `issue` is specified.
The name of the repository (e.g., 'octocat/Hello-World') where the changes in the pull request were made. This field is required for cross-repository pull requests if both the source and target repositories are owned by the same organization but are different repositories.
Indicates whether maintainers of the upstream repository can modify the pull request. This is primarily relevant for pull requests originating from forks.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_REFERENCECreates a NEW Git reference (branch or tag) in a repository. IMPORTANT: This action ONLY creates NEW references - if the reference already exists, it will fail with a 422 'Reference already exists' error. To update an existing reference, use the 'Update a reference' (GITHUB_UPDATE_A_REFERENCE) action instead. The repository must not be empty prior to this operation.
Input parameters
Fully qualified reference to create (e.g., `refs/heads/master`, `refs/tags/v1.0.0`). Must start with `refs/` and contain at least two slashes.
SHA-1 hash of an existing commit in the repository that the new reference will point to.
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_REGISTRATION_TOKEN_FOR_AN_ORGANIZATIONGenerates a temporary (one-hour) registration token to add a new self-hosted runner to an organization for GitHub Actions.
Input parameters
The name of the organization. This name is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_REGISTRATION_TOKEN_FOR_A_REPOSITORYGenerates a time-limited token required to register a new self-hosted runner with a specific repository.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username of the account or the organization name that owns the repository. This field is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_RELEASECreates a release in a GitHub repository for a specified tag; the tag must be unique for published releases, and if a `discussion_category_name` is given, it must already exist.
Input parameters
A detailed description of the release. Markdown formatting is supported.
The title of the release. If omitted and `generate_release_notes` is false, it defaults to the `tag_name`.
The name of the repository, without the .git extension. This field is not case-sensitive.
Set to `true` to create an unpublished (draft) release. Defaults to `false`.
The account owner of the repository (username or organization name). This field is not case-sensitive.
The name of the tag for this release. This tag must be unique for published releases.
Set to `true` to identify this release as a pre-release. Defaults to `false`.
Specifies if this release should be marked as the latest for the repository. Draft releases and prereleases cannot be set as 'latest'.
Specifies the commitish value (e.g., branch name, tag name, or commit SHA) from which the Git tag is created. Defaults to the repository's default branch if the tag specified in `tag_name` doesn't exist yet.
Set to `true` to automatically generate the release title (`name`) and description (`body`) from the commit history since the last release. Defaults to `false`.
If specified, a new discussion will be created in this category and linked to the release. The category must already exist in the repository's discussions.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_REMOVE_TOKEN_FOR_AN_ORGANIZATIONGenerates a token, valid for one hour, to authenticate removing a self-hosted runner from an organization.
Input parameters
The unique identifier or name of the GitHub organization. This name is not case-sensitive. For example, if your organization's URL is github.com/my-org, 'my-org' is the value.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_REMOVE_TOKEN_FOR_A_REPOSITORYGenerates a temporary (one-hour validity) token required to unregister and remove a self-hosted runner from a repository.
Input parameters
Name of the repository, without the `.git` extension (not case-sensitive).
Username of the account owning the repository (not case-sensitive).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_REPLY_FOR_A_REVIEW_COMMENTPosts a reply to a specific review comment on a GitHub pull request, requiring the repository, pull request, and original comment to exist, and a non-empty reply body.
Input parameters
The text of the reply to the review comment.
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
The unique identifier of the top-level review comment to which the reply is being made. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.
The number that identifies the pull request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_REPOSITORY_DISPATCH_EVENTTriggers a GitHub Actions workflow or a webhook on a repository by creating a repository dispatch event, allowing programmatic triggering of workflows based on events outside of GitHub.
Input parameters
The name of the repository, without the `.git` extension (not case-sensitive).
The account owner of the repository (not case-sensitive).
Custom webhook event name (100 characters or fewer).
JSON string containing extra information for the webhook event (max 10 top-level properties), passed to the triggered workflow or action. Example: '{"ref": "main", "sha": "abc123"}'
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_REPOSITORY_FOR_THE_AUTHENTICATED_USERCreates a new repository for the authenticated user, optionally within an organization if `team_id` is specified.
Input parameters
The name of the repository. Must be unique within your account. Will be used in the repository URL (github.com/username/repo-name). Can only contain alphanumeric characters, hyphens, underscores, and periods.
Whether the repository is private (true) or public (false).
The ID of the team to be granted access. Only valid if creating in an organization.
Whether the wiki is enabled.
A URL with more information about the repository.
Whether to initialize the repository with a README.
Whether issues are enabled.
A short description of the repository.
Whether this repository is a template repository.
Whether projects are enabled.
Whether downloads are enabled (deprecated by GitHub and may not be configurable).
Whether discussions are enabled.
Whether to allow auto-merge on pull requests.
SPDX license key identifier (lowercase). Examples: 'mit', 'apache-2.0', 'gpl-3.0'. Must be one of the GitHub-supported licenses.
Whether to allow merging pull requests with a merge commit.
Whether to allow rebase-merging pull requests.
Whether to allow squash-merging pull requests.
Desired .gitignore template (e.g., 'Python', 'Node').
The default title for a merge commit. `PR_TITLE` uses the pull request's title. `MERGE_MESSAGE` uses a classic title like 'Merge pull request #123 from branch-name'. Required when `merge_commit_message` is set. Valid combinations: (PR_TITLE, PR_BODY), (PR_TITLE, BLANK), (MERGE_MESSAGE, PR_TITLE).
The default message for a merge commit. `PR_BODY` uses the pull request's body. `PR_TITLE` uses the pull request's title. `BLANK` results in a blank commit message. Valid combinations with merge_commit_title: (PR_TITLE, PR_BODY), (PR_TITLE, BLANK), (MERGE_MESSAGE, PR_TITLE).
Whether to automatically delete head branches when pull requests are merged.
The default title for a squash merge commit. `PR_TITLE` uses the pull request's title. `COMMIT_OR_PR_TITLE` uses the commit's title (if only one commit) or the pull request's title (if multiple commits).
The default message for a squash merge commit. `PR_BODY` uses the pull request's body. `COMMIT_MESSAGES` uses the branch's commit messages. `BLANK` results in a blank commit message.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_REPOSITORY_FROM_AN_UNPUBLISHED_CODESPACEPublishes the specified codespace to a new repository, using the codespace's current state as the initial commit.
Input parameters
The desired name for the new repository to be created from the codespace. If omitted, GitHub might generate a name (e.g., based on the codespace name).
Specifies the visibility of the new repository. Set to `true` for a private repository, or `false` for a public one. Defaults to `false` (public).
The unique name of the codespace to be published as a new repository. This codespace must exist, be unpublished, and belong to the authenticated user.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_REPOSITORY_PROJECTCreates a new GitHub Projects V2 project board linked to a specified repository. Note: This action uses GitHub's Projects V2 GraphQL API. The legacy Projects V1 REST API has been sunset by GitHub. The project is owned by the repository owner (user or organization) and linked to the specified repository.
Input parameters
An optional detailed description for the project board. Note: GitHub Projects V2 does not support a body/description field during creation, so this field is accepted but not used.
The name of the project board to be created.
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_REPOSITORY_RULESETCreates a uniquely named ruleset for a repository, defining rules for branches or tags with specified enforcement, conditions, and bypass actors.
Input parameters
Unique name for the ruleset.
Name of the repository, without the `.git` extension (not case-sensitive).
Account owner of the repository (not case-sensitive).
Array of rule objects as a JSON string to be enforced. Each must have `type` and may have `parameters`. Refer to GitHub API docs for available rule types and parameters. Example: '\[{"type": "creation"}, {"type": "deletion"}\]'
The target of the ruleset, whether it applies to branches or tags.
Enforcement level: `disabled` (ruleset is not enforced), `active` (ruleset is enforced), or `evaluate` (test rules before enforcing; GitHub Enterprise only).
Actors that can bypass rules in this ruleset as a JSON string. Each actor object requires `actor_id`, `actor_type` (e.g., 'Team', 'Integration'), and `bypass_mode` (e.g., 'always'). Example: '\[{"actor_id": 1, "actor_type": "Team", "bypass_mode": "always"}\]'
Ref names or patterns to exclude. Condition fails if any pattern matches the ref name.
Ref names/patterns to include. Condition passes if one pattern matches the ref name. Use `~DEFAULT_BRANCH` for default branch, `~ALL` for all branches.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_REPOSITORY_USING_A_TEMPLATECreates a new repository from an existing template repository; the authenticated user must have access to the template and, if creating in an organization, repository creation permissions within it.
Input parameters
The desired name for the new repository to be created.
The username or organization name that will own the new repository. Defaults to the authenticated user if not provided.
Set to `true` to create a private repository, or `false` to create a public repository.
A brief summary or description for the new repository.
The name of the template repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the template repository. This field is not case-sensitive.
Set to `true` to copy the directory structure and files from all branches of the template repository, not just the default branch.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_REPOSITORY_VARIABLECreates a new, unencrypted variable in a repository for GitHub Actions workflows; fails if a variable with the same name already exists.
Input parameters
The name of the variable to create. Variable names are case-sensitive and can only contain alphanumeric characters (\[a-z\], \[A-Z\], \[0-9\]) or underscores (_). They cannot start with the `GITHUB_` prefix, and spaces are not allowed.
The name of the repository, without the `.git` extension. This field is not case sensitive.
The username or organization name that owns the repository. This field is not case sensitive.
The value of the variable. This will be stored as a string.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_REPOSITORY_WEBHOOKCreates a webhook for a specified repository; requires admin permissions on the repository.
Input parameters
Name of the webhook. Use `web`. This parameter currently only accepts `web` and defaults to `web` if not provided.
The name of the repository without the `.git` extension. This name is not case sensitive.
The account owner of the repository. This name is not case sensitive.
Determines if notifications are sent when the webhook is triggered. `true` sends notifications (active), `false` disables them (inactive).
List of events to trigger the webhook (e.g., `\['push'\]`, `\['issues'\]`). See GitHub documentation for 'webhook event payloads'.
The URL to which webhook payloads will be delivered via POST for subscribed events.
Optional secret string for HMAC hex digest in delivery signature headers, enhancing security. See GitHub's 'delivery signature headers' documentation for details.
Media type for serializing payloads: `json` or `form`. Defaults to `form` if not specified. `json` delivers JSON, `form` delivers URL-encoded data.
Determines SSL certificate verification for the payload URL: "0" to verify SSL (recommended), or "1" to skip. Defaults to "0" (verify SSL) if not provided.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_REVIEW_COMMENT_FOR_A_PULL_REQUESTCreates a review comment on a pull request's diff, targeting a specific line, range of lines, an entire file, or replying to an existing comment.
Input parameters
Text content of the review comment.
**\[LINE-BASED MODE\]** Line number in the diff for the comment. Required when using line-based mode (must be used with `side`). For multi-line comments, this is the last line of the range. Do not use with position or in_reply_to parameters.
Relative path of the file for the comment.
Repository name without the `.git` extension (not case sensitive).
**\[LINE-BASED MODE\]** Side of the diff (`LEFT` or `RIGHT`) for the comment. Required when using line-based mode with the `line` parameter. For multi-line comments, refers to the last line of the range. Do not use with position or in_reply_to parameters. **IMPORTANT:** Use `LEFT` only for deletions that appear in red in the diff. Use `RIGHT` for additions (green) or unchanged context lines (white). Attempting to comment on LEFT side lines that are not visible deletions in the diff will result in a 'could not be resolved' error.
Account owner of the repository (not case sensitive).
**\[DEPRECATED - Use line-based mode instead\]** Position in the diff hunk for the comment. When using position mode, do not provide line, side, start_line, start_side, or in_reply_to parameters.
SHA of the commit for the comment. Using an outdated `commit_id` can misplace the comment if lines change.
**\[LINE-BASED MODE - MULTI-LINE\]** First line in the diff for a multi-line comment. Required when creating a multi-line comment (must be used with `start_side`, `line`, and `side`). Do not use with position or in_reply_to parameters.
**\[LINE-BASED MODE - MULTI-LINE\]** Starting side of the diff (`LEFT` or `RIGHT`) for a multi-line comment. Required when creating a multi-line comment (must be used with `start_line`, `line`, and `side`). Do not use with position or in_reply_to parameters. **IMPORTANT:** Use `LEFT` only for deletions that appear in red in the diff. Use `RIGHT` for additions (green) or unchanged context lines (white). Attempting to use LEFT for lines that are not visible deletions will result in a 'could not be resolved' error.
**\[REPLY MODE\]** ID of an existing review comment to reply to. When using reply mode, do not provide position, line, side, start_line, or start_side parameters as they will be ignored.
Identifier of the pull request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_REVIEW_FOR_A_PULL_REQUESTCreates a pull request review, allowing approval, change requests, or comments; `body` is required if `event` is `REQUEST_CHANGES` or `COMMENT`, and omitting `event` makes the review `PENDING`.
Input parameters
Review's main body text; required if `event` is `REQUEST_CHANGES` or `COMMENT`.
Repository name, without the `.git` extension (case-insensitive).
Review action type (`APPROVE`, `REQUEST_CHANGES`, `COMMENT`); if omitted, review is `PENDING` and requires later submission.
Username of the account owning the repository (case-insensitive).
Inline draft review comments. Each object requires `path` (relative file path) and `body` (comment text). Optionally, specify `line` (or `start_line` for multi-line), and `side` (or `start_side`) for diff location. `position` is deprecated; use `line`. Example: `\[{'path': 'file.py', 'line': 10, 'body': 'Refactor this.'}\]`
SHA of the commit to review; defaults to the latest pull request commit. Outdated SHAs may lead to stale comments.
Identifying number of the pull request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_SCOPED_ACCESS_TOKENExchanges a user-to-server token for a new, fine-grained scoped access token for a GitHub App, requiring `client_id`, `access_token`, either `target` or `target_id`, and at least one permission; for repository-specific scoping, provide either `repositories` (names) or `repository_ids` (IDs), but not both.
Input parameters
Username or organization name for scoping the new token. Required if `target_id` is not provided.
Client ID of the GitHub App.
ID of the user or organization for scoping the new token. Required if `target` is not provided.
User-to-server access token to be exchanged for a new scoped token.
Repository names to scope the new token to. Cannot be used if `repository_ids` is specified.
Repository IDs to scope the new token to. Cannot be used if `repositories` is specified.
Permission for GitHub Pages settings, statuses, configurations, builds, and creating new builds. Applies to target repositories.
Permission for checks on code (e.g., CI statuses). Applies to target repositories.
Permission for issues, comments, assignees, labels, and milestones. Applies to target repositories.
Permission for GitHub Actions workflows, workflow runs, and artifacts. Applies to target repositories.
Permission for organization members and teams. Applies to target organization.
Permission to manage profile settings for the user account. Applies to target user.
Permission for repository secrets (e.g., Actions secrets). Applies to target repositories.
Permission for repository contents, commits, branches, downloads, releases, and merges. Applies to target repositories.
Read-only permission for repository metadata, search, and collaborator listing. Applies to target repositories.
Permission for packages in GitHub Packages. Applies to target repositories or organization.
Permission to list and manage repositories a user is starring. Applies to target user.
Permission for commit statuses. Applies to target repositories.
Permission to manage followers for the user account. Applies to target user.
Permission to view and manage GPG keys for the user account. Applies to target user.
Permission for updating GitHub Actions workflow files. Requires `contents: write`. Applies to target repositories.
Permission for Codespaces. Applies to target user/organization if repositories are not specified, otherwise to target repositories.
Permission for deployments and deployment statuses. Applies to target repositories.
Permission for repository environments. Applies to target repositories.
Permission to access specific files in targeted repositories. The file paths must be configured in the GitHub App settings.
Permission for repository administration (settings, teams, collaborators). Applies to target repositories.
Permission to manage Git SSH keys for the user account. Applies to target user.
Permission for pull requests, comments, assignees, labels, milestones, and merges. Applies to target repositories.
Permission to manage email addresses for the user account. Applies to target user.
Permission for security events (e.g., code scanning alerts). Applies to target repositories.
Permission for repository webhooks. Applies to target repositories.
Permission for team discussions and related comments. Applies to target organization.
Read-only permission for viewing an organization's billing plan. Applies to target organization.
Permission for Dependabot secrets for targeted repositories.
Permission to view and manage interaction limits on a repository. Applies to target repositories or organization.
Permission for organization webhooks. Applies to target organization.
Read-only permission to view organization audit log events. Applies to target organization.
Permission for repository projects, columns, and cards. Applies to target repositories.
Permission for organization-level secrets (e.g., Actions secrets). Applies to target organization.
Permission for Dependabot alerts. Applies to target repositories.
Permission for organization-level GitHub Packages. Applies to target organization.
Permission for organization projects and projects beta (if available). Applies to target organization.
Permission for secret scanning alerts. Applies to target repositories.
Permission for custom repository roles within an organization. Applies to target organization.
Permission for administrative settings of an organization. Applies to target organization.
Permission for viewing and managing users blocked by the organization. Applies to target organization.
Permission to view and edit repository custom properties, if allowed by property definition. Applies to target repositories.
Permission for custom organization roles. Applies to target organization.
Permission for custom properties for an organization. Applies to target organization.
Permission to view and manage organization announcement banners. Applies to target organization.
Permission for GitHub Actions self-hosted runners for an organization. Applies to target organization.
Permission for fine-grained personal access tokens requested by organization members. Applies to target organization.
Permission for GitHub Copilot seat assignments for organization members (beta). Applies to target organization.
Permission for requests for fine-grained personal access tokens within an organization. Applies to target organization.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_SNAPSHOT_OF_DEPENDENCIES_FOR_A_REPOSITORYCreates a snapshot of a repository's dependencies to populate the GitHub dependency graph and enable security alerts; `sha` must be a 40-character commit ID, `ref` a fully qualified Git reference (e.g., `refs/heads/main`), and `scanned` an ISO 8601 timestamp.
Input parameters
Git reference (fully qualified, e.g., `refs/heads/main`) of the repository branch/tag that triggered this snapshot.
Commit SHA (maximum 40 characters) associated with this dependency snapshot.
Repository name, without `.git` extension (name is not case-sensitive).
Account owner of the repository (name is not case-sensitive).
Optional external ID of the job that generated this snapshot.
UTC timestamp (ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ) when the snapshot was taken.
Version of the dependency snapshot submission, typically of the manifest or lock file format.
Optional user-defined metadata as a JSON string for domain-specific information. Limited to 8 keys with scalar values (e.g., string, number, boolean). Example: '{"key1": "value1", "key2": 123}'
Optional collection of package manifests as a JSON string (e.g., package-lock.json, pom.xml). Keys are manifest file names; values detail dependencies. Example: '{"package-lock.json": {"name": "...", "resolved": {...}}}'
Optional URL of the detector tool used.
Optional name of the tool used to detect dependencies.
Optional URL for the job that generated this snapshot.
Optional string to group snapshots. For a given `job.correlator` and `detector.name`, only the 'latest' snapshot is current. Useful to distinguish detection runs (e.g., concatenating GITHUB_WORKFLOW and GITHUB_JOB).
Optional version of the detector tool used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_TAG_OBJECTCreates an annotated Git tag object in a repository, pointing to an existing Git object (commit, tree, or blob) defined by its SHA and ensuring the `type` field correctly specifies the object's type.
Input parameters
The name of the tag, typically a version identifier (e.g., "v0.0.1").
The name of the repository, without the `.git` extension. This name is not case-sensitive.
The type of the Git object being tagged.
The account owner of the repository. This name is not case-sensitive.
The SHA of the Git object (commit, tree, or blob) that this tag is pointing to.
The message associated with the tag.
The timestamp for when this object was tagged. This should be in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
The name of the person creating the tag.
The email address of the person creating the tag.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_TAG_PROTECTION_STATE_FOR_A_REPOSITORYDEPRECATED: This API was sunset on August 30, 2024. Use GITHUB_CREATE_A_REPOSITORY_RULESET instead to create tag protection rules via repository rulesets.
Input parameters
The name of the repository without the `.git` extension. Not case sensitive.
The account owner of the repository (username or organization name). Not case sensitive.
Glob pattern to protect tags. Examples: `v1.*` (protects tags starting with `v1.`), `*` (protects all tags).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_TEAMCreates a new team in an organization, optionally with maintainers, repositories, specific privacy, notification settings, or a parent team; if `parent_team_id` is given, `privacy` must be 'closed'.
Input parameters
Organization name where the team will be created (not case-sensitive).
Name of the new team.
Team privacy: 'secret' (visible to owners and members) or 'closed' (visible to all org members). Defaults to 'secret' for non-nested teams; must be 'closed' if `parent_team_id` is set.
**Deprecated**. Default repository permission ('pull' for read access, 'push' for write access) for the team.
Repository full names (e.g., "org-name/repo-name") for team access; repositories must exist and be accessible to the organization.
Team's purpose or focus.
GitHub user handles of organization members to be team maintainers; users must be organization members.
ID of an existing team to be the parent, creating a nested team. If provided, new team `privacy` must be 'closed'.
Notification settings for @mentions: 'notifications_enabled' (members notified) or 'notifications_disabled' (no one notified). Default: 'notifications_enabled'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_TEMPORARY_PRIVATE_FORKCreates a temporary private fork of the specified repository to address a security vulnerability, linking the fork to a GHSA ID that must be specifically associated with this repository; the fork may take up to 5 minutes to become accessible.
Input parameters
Name of the repository, without the `.git` extension; not case-sensitive.
Account owner (username or organization) of the repository; not case-sensitive.
Identifier for the GitHub Security Advisory (e.g., GHSA-rfv9-x7w6-39px) that the fork will address.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_TREECreates a new Git tree object in a repository, defining file/directory structure by specifying tree entries, optionally building on a `base_tree` SHA; all provided SHAs must be valid.
Input parameters
The name of the repository without the `.git` extension. The name is not case sensitive.
Array of objects defining the tree structure. Each object (node) requires `path` (string), `mode` (string; e.g., '100644' file, '100755' executable, '040000' subdirectory/tree, '160000' submodule, '120000' symlink), and `type` (string: 'blob', 'tree', or 'commit'). For new/updated blobs, provide `content` (UTF-8 string). For existing objects or `tree`/`commit` types, provide `sha` (string). To delete, specify `path`, `mode`, `type`, and set `sha` to `null`.
The account owner of the repository. The name is not case sensitive.
SHA1 of an existing Git tree object to use as a base. If provided, its entries are combined with `tree` entries, where `tree` entries overwrite those from `base_tree` with the same path. Typically the SHA1 of the latest commit's tree for new branch changes. If omitted, the new tree is built from `tree` entries; files from the parent commit's tree not in `tree` are treated as deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_USER_PROJECTCreates a new GitHub Projects V2 project board for the authenticated user to organize and track issues, pull requests, and notes. Note: This action uses GitHub's Projects V2 GraphQL API. The legacy Projects V1 REST API has been sunset by GitHub.
Input parameters
Optional description for the new project. Note: GitHub Projects V2 does not support a body/description field during creation, so this field is accepted but not used.
Name/title for the new project. This will be displayed as the project board title.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_A_WORKFLOW_DISPATCH_EVENTManually triggers a GitHub Actions workflow identified by `workflow_id` at a given `ref`, if the workflow is configured to accept `workflow_dispatch` events.
Input parameters
Git reference (branch or tag) for the workflow.
Repository name, excluding the `.git` extension (case-insensitive).
Owner of the repository (username or organization, case-insensitive).
JSON string containing key-value inputs for the workflow, matching `on.workflow_dispatch.inputs` definitions (max 10); uses workflow defaults if omitted. Example: '{"actor": "mona", "environment": "production"}'
Identifier of the workflow: numeric ID or just the filename (e.g., 'main.yml'). If a full path like '.github/workflows/main.yml' is provided, the prefix is automatically stripped.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_COMMIT_SIGNATURE_PROTECTIONEnables commit signature protection for a specified branch, requiring all new commits to be signed.
Input parameters
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use \[the GraphQL API\](https://docs.github.com/graphql).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_DEPLOYMENT_PROTECTION_RULEEnables a custom deployment protection rule for an existing environment in a repository by linking a configured GitHub App (via `integration_id`) to control deployments.
Input parameters
The name of the repository where the environment exists. Do not include the `.git` extension. This name is not case sensitive.
The GitHub username or organization name that owns the repository. This name is not case sensitive.
The unique identifier of the GitHub App that provides the custom deployment protection rule. This app must be installed and configured for the repository. Required - use GITHUB_LIST_ENVIRONMENT_CUSTOM_DEPLOYMENT_RULES to find available integration IDs for your environment.
The name of the environment to which the protection rule will be applied. This name must be URL-encoded if it contains special characters (e.g., slashes `/` should be replaced with `%2F`).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_DRAFT_ITEM_FOR_USER_PROJECTCreates a draft issue item in a user-owned GitHub ProjectsV2. Use when you need to add a new draft item to track ideas or tasks in a user's project.
Input parameters
The body content of the draft issue item to create in the project.
The title of the draft issue item to create in the project.
The handle for the GitHub user account.
The project's number.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_INFERENCE_CHAT_COMPLETIONSTool to create chat completions using GitHub Models inference API. Use when you need to generate AI-powered text responses using models like GPT-4, Claude, or Llama through GitHub's inference endpoint.
Input parameters
If specified, the system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result.
Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.
ID of the specific model to use for the request. Format: {publisher}/{model_name}, e.g., openai/gpt-4o, anthropic/claude-3.5-sonnet.
A list of tools (functions) the model may call. The model will choose when and how to call these functions based on the conversation context.
An alternative to temperature called nucleus sampling. Range: \[0.0, 1.0\]. The model considers tokens with top_p probability mass.
If true, partial message deltas will be sent as data-only server-sent events as they become available.
The collection of context messages associated with this chat completion request. Each message must have a role (assistant, developer, system, or user) and content.
Maximum number of tokens to generate in the completion. The total length of input tokens and generated tokens is limited by the model's context length.
List of supported modalities for this request. Supported values: text, audio.
Controls the apparent creativity of generated completions. Range: \[0.0, 1.0\]. Lower values make output more deterministic, higher values more random.
Controls which (if any) tool is called by the model.
Options for streaming responses.
Specifies the format of the model's output.
Influences probability of generated tokens appearing based on whether they appear in the text so far. Range: \[-2.0, 2.0\]. Positive values increase likelihood of new topics.
Influences probability of generated tokens appearing based on their cumulative frequency in the text so far. Range: \[-2.0, 2.0\]. Positive values decrease likelihood of repetition.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_INFERENCE_EMBEDDINGSTool to create inference embeddings using GitHub's AI models. Use when you need to convert text into vector representations for similarity search, clustering, or other ML tasks.
Input parameters
A unique identifier representing your end-user, which can help monitor and detect abuse.
Input text to embed, encoded as a string or array of strings. Each string will be converted to an embedding vector.
ID of the specific model to use for the request. Format: {publisher}/{model_name}
The number of dimensions the resulting output embeddings should have. Must be supported by the model (max 2048).
Format for embeddings: 'float' (default) or 'base64'. Float returns arrays of numbers, base64 returns encoded strings.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_ISSUE_TYPECreate a new issue type for a GitHub organization. Requires the authenticated user to be an organization administrator. OAuth tokens need admin:org scope.
Input parameters
The organization name (case-insensitive).
The name of the issue type.
The color of the issue type.
Whether the issue type is enabled at the organization level.
A short description of the issue type.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_JIT_RUNNER_CONFIGGenerates a temporary Just-In-Time (JIT) configuration for a new self-hosted GitHub Actions runner for a repository; any specified non-default `runner_group_id` must be an existing runner group accessible by the repository.
Input parameters
The desired name for the new self-hosted runner.
The name of the repository, without the '.git' extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
A list of custom labels to assign to the runner. These labels help in targeting specific runners for jobs. Minimum items: 1. Maximum items: 100.
The working directory for the runner, relative to its installation path. This is where job execution will take place.
The unique identifier of the runner group to which the new runner will be assigned. Use 0 for the default group or the ID of a specific runner group.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_OR_UPDATE_AN_ENVIRONMENTCreates a new environment or updates an existing one in a GitHub repository, allowing configuration of deployment protection rules such as wait timers and reviewers; ensure `environment_name` is URL-encoded if it contains special characters.
Input parameters
Name of the repository, without the `.git` extension (not case-sensitive).
The username or organization name of the repository owner (not case-sensitive).
JSON string containing up to 6 users or teams allowed to review deployments. Reviewers need at least read access; one approval suffices. Each reviewer object requires `id` and `type` ('User' or 'Team'). Example: '\[{"id": 4532, "type": "User"}\]'
Time in minutes to delay a job after it's triggered (0-43,200, i.e., up to 30 days).
Name of the environment. URL-encode if it contains special characters (e.g., '/' becomes '%2F').
If true, prevents the user who triggered deployment from approving their own job.
If true, only branches with existing protection rules can deploy; `deployment_branch_policy_custom_branch_policies` must then be false.
If true, deployment is restricted to branches matching custom name patterns; `deployment_branch_policy_protected_branches` must then be false.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_OR_UPDATE_AN_ENVIRONMENT_SECRETCreates or updates an environment secret with an `encrypted_value` that was encrypted using the public key identified by `key_id` for the specified environment.
Input parameters
The name of the repository. Not case-sensitive.
The account owner of the repository. Not case-sensitive.
ID of the public key used for encryption, obtained from the 'Get an environment public key' GitHub API endpoint.
Name of the secret. Case-sensitive.
Value of the secret, encrypted with LibSodium using the public key obtained from the 'Get an environment public key' GitHub API endpoint for the target environment.
Name of the environment. Case-sensitive; URL-encode special characters (e.g., `/` becomes `%2F`).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_OR_UPDATE_AN_ORGANIZATION_SECRETCreates or updates an organization secret for GitHub Actions, requiring its value to be pre-encrypted via LibSodium using the organization's public key.
Input parameters
The organization name. The name is not case sensitive.
ID of the public key (from 'Get an organization public key' endpoint) used for encryption. This is required for both creating and updating secrets.
Controls which repositories can access the secret. If 'selected', `selected_repository_ids` must be provided.
The name of the secret.
Value for the secret, pre-encrypted using LibSodium with the organization's public key (obtained from 'Get an organization public key' endpoint). This is required for both creating and updating secrets.
List of repository IDs that can access this secret. Required and only applicable when `visibility` is 'selected'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_OR_UPDATE_A_REPOSITORY_SECRETCreates or updates a GitHub Actions secret within a specific repository; use `encrypted_value` and `key_id` to set or change its value.
Input parameters
The repository name, without the `.git` extension (case-insensitive).
The repository owner's username or organization name (case-insensitive).
ID of the public key used to encrypt `encrypted_value` (obtained with the public key). Required if `encrypted_value` is provided.
The name for the secret being created or updated. Must not start with 'GITHUB_' prefix (reserved for GitHub internal secrets).
Value for the secret, pre-encrypted with the repository's public key using LibSodium (public key is obtained via 'Get a repository public key' endpoint).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_OR_UPDATE_A_SECRET_FOR_THE_AUTHENTICATED_USERCreates or updates a Codespaces secret for the authenticated user; `encrypted_value` must be encrypted with the public key (ID: `key_id`) from GitHub's 'Get public key for the authenticated user' endpoint.
Input parameters
ID of the public key (from GitHub's 'Get public key for the authenticated user' endpoint) used to encrypt `encrypted_value`. If not provided, it will be fetched automatically.
The name of the secret. This name must be unique among the user's Codespaces secrets.
The plaintext value for your secret. This will be automatically encrypted using the user's Codespaces public key before being sent to GitHub. If you already have an encrypted value, use the encrypted_value parameter instead.
Secret's value, encrypted using \[LibSodium\](https://libsodium.gitbook.io/doc/bindings_for_other_languages) with the public key (see `key_id`) obtained from GitHub's 'Get public key for the authenticated user' endpoint.
Repository IDs that can access this secret. If omitted or empty, accessible to all user's Codespaces-enabled repositories.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_OR_UPDATE_CUSTOM_PROPERTIES_FOR_AN_ORGCreates new custom property schemas or updates existing ones in bulk for a specified organization; each property definition must include `property_name` and `value_type`.
Input parameters
The case-insensitive organization name.
Definitions for custom properties as a JSON string. Each must include a unique `property_name` (max 75 chars, no spaces) and `value_type`. Optional: `description`, `required`, `default_value`, `allowed_values` (for 'single_select' type).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_OR_UPDATE_CUSTOM_PROPERTY_ORGCreates a new custom property (name must be unique for creation) or updates an existing one for an organization to define metadata for its repositories.
Input parameters
The organization's unique identifier (case-insensitive).
If true, property must be set for all repositories and `default_value` is mandatory.
Data type of the custom property. Can be 'string' (free text), 'single_select' (single choice from list), 'multi_select' (multiple choices from list), 'true_false' (boolean), or 'url' (URL format).
Explanation of the custom property's purpose.
Default value if property isn't set. For `single_select` type, must be one of `allowed_values`. Can be a string for single values or an array for multi_select.
Ordered list of allowed values (up to 200). Required and non-empty if `value_type` is `single_select` or `multi_select`.
Who can edit the values of the property. Can be 'org_actors' (organization actors only) or 'org_and_repo_actors' (organization and repository actors).
Name of the custom property (case-sensitive).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_OR_UPDATE_FILE_CONTENTSCreates a new file or updates an existing file in a GitHub repository; SHA can be provided to validate file updates, automatically fetched if not provided.
Input parameters
The blob SHA of the file being replaced. Automatically fetched if not provided. If a 409 conflict occurs (SHA mismatch due to concurrent modifications), the action will automatically retry up to 5 times with exponential backoff and jitter.
The full path to the file in the repository, including the filename and extension. Do not include leading slashes.
The name of the repository (not case sensitive, without the `.git` extension).
The account owner of the repository (not case sensitive).
The branch name. Defaults to the repository's default branch if omitted. If a non-existent branch is specified, the action will automatically fall back to the repository's default branch. For empty repositories, omitting this parameter is recommended to let GitHub initialize with the repository's configured default branch.
The new file content. Can be provided as plain text (will be automatically encoded to Base64) or as Base64-encoded text. GitHub API requires Base64 encoding, which this action handles automatically.
The commit message for this file creation or update.
Author's timestamp (ISO 8601 format). Defaults to committer's date if author details are provided but date is not.
Author's name. If specified, `author_email` is also required. Defaults to committer details; if all committer/author details omitted, GitHub uses authenticated user.
Author's email. If specified, `author_name` is also required. Defaults to committer details; if all committer/author details omitted, GitHub uses authenticated user.
Committer's commit timestamp (ISO 8601 format). Defaults to current time if committer details are provided but date is not.
Committer's name. If specified, `committer_email` is also required. GitHub uses authenticated user if all committer/author details omitted.
Committer's email. If specified, `committer_name` is also required. GitHub uses authenticated user if all committer/author details omitted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_OR_UPDATE_GITHUB_PAGES_SITETool to enable or update GitHub Pages configuration for a repository. Use when setting up GitHub Pages for static site deployment or modifying Pages settings like custom domains and HTTPS enforcement.
Input parameters
The name of the repository without the .git extension. Not case-sensitive.
Custom domain for the Pages site (e.g., 'example.com'). Set to null to remove custom domain. Only used during updates.
The account owner of the repository (username or organization). Not case-sensitive.
Build process type: 'legacy' for traditional GitHub Pages build from a branch, 'workflow' for GitHub Actions. When 'workflow', source_branch and source_path are ignored.
The directory path within source_branch containing the site files: '/' for root or '/docs' for docs folder. Ignored if build_type is 'workflow'.
The repository branch to use for GitHub Pages source (e.g., 'main', 'gh-pages'). Required if build_type is 'legacy'. Ignored if build_type is 'workflow'.
Whether to enforce HTTPS for the Pages site. Only used during updates.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_OR_UPDATE_REPO_SECRET_WITH_ENCRYPTED_VALUECreates or updates a Dependabot secret in a repository using an `encrypted_value` (pre-encrypted with LibSodium using the repository's Dependabot public key) and its corresponding `key_id`. This action allows you to securely manage secrets for a given repository, ensuring that sensitive data remains protected during the update process. By providing the encrypted value alongside the key ID, you can seamlessly maintain the necessary credentials for your repository's operations.
Input parameters
The name of the repository, without the `.git` extension. This name is not case-sensitive.
The account owner of the repository (e.g., a GitHub username or organization name). This name is not case-sensitive.
The ID of the public key that was used to encrypt the secret value. This ID is retrieved from GitHub along with the public key via the 'Get a repository public key' endpoint for Dependabot secrets. If not provided or if an outdated key_id is used, the action will automatically fetch the latest public key from GitHub and retry with the current key_id.
The name of the Dependabot secret to create or update.
Value for your secret. This value must be encrypted with LibSodium, using the public key retrieved from the GitHub API's 'Get a repository public key' endpoint for Dependabot secrets. The resulting encrypted string is typically Base64 encoded.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_REACTION_FOR_A_COMMIT_COMMENTCreates an emoji reaction for a commit comment; if the user has already reacted with the same content, details of the existing reaction are returned.
Input parameters
Name of the repository, without the `.git` extension. Not case-sensitive.
Username of the repository owner. Not case-sensitive.
The \[reaction type\](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the commit comment.
Unique ID of the commit comment.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_REACTION_FOR_AN_ISSUECreates a reaction for a specified issue within a GitHub repository.
Input parameters
The name of the repository without the `.git` extension. The name is not case-sensitive.
The account owner of the repository. The name is not case-sensitive.
The reaction type to add to the issue. See the \[GitHub documentation on reactions\](https://docs.github.com/rest/reactions/reactions#about-reactions) for full details.
The number that identifies the issue.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_REACTION_FOR_AN_ISSUE_COMMENTCreates a reaction for a specific comment on an issue within a GitHub repository.
Input parameters
Name of the repository, without the `.git` extension (not case-sensitive).
Username of the account that owns the repository (not case-sensitive).
Reaction content to add to the issue comment. Must be one of the values from `ContentEnm`.
Unique identifier of the issue comment.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_REACTION_FOR_A_PULL_REQUEST_REVIEW_COMMENTAdds a specified reaction to a pull request review comment within a GitHub repository.
Input parameters
The name of the repository, without the `.git` extension. This field is case-insensitive.
The username or organization name that owns the repository. This field is case-insensitive.
The reaction to add. See the \[GitHub API documentation on reactions\](https://docs.github.com/rest/reactions/reactions#about-reactions) for more context on reactions.
The unique identifier of the pull request review comment to which the reaction will be added.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_REACTION_FOR_A_RELEASECreates an emoji reaction for a specific, existing release in a GitHub repository.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username of the account that owns the repository. This field is not case-sensitive.
The type of reaction to add to the release.
The unique identifier (ID) of the release to add a reaction to.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_REACTION_FOR_A_TEAM_DISCUSSIONCreates a reaction for a team discussion within a GitHub organization.
Input parameters
The name of the GitHub organization. This field is not case-sensitive.
The reaction content to add to the team discussion.
The slug (URL-friendly version) of the team name.
The unique number identifying the team discussion.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_REACTION_FOR_A_TEAM_DISCUSSION_COMMENTAdds a reaction to a team discussion comment, requiring the specified organization, team, discussion, and comment to exist.
Input parameters
The organization name on GitHub. This name is not case sensitive.
The type of reaction to add to the team discussion comment. For more information on reaction types, see the \[GitHub API documentation on reactions\](https://docs.github.com/rest/reactions/reactions#about-reactions).
The slug (URL-friendly version) of the team name.
The unique number identifying the comment within the discussion.
The unique number identifying the team discussion.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_SPONSORSHIPTool to start a new GitHub sponsorship or reactivate a past sponsorship using GraphQL. Use when you need to sponsor a maintainer through GitHub Sponsors with a specified amount and privacy level.
Input parameters
The amount to sponsor in cents (USD). For example, 500 cents equals $5.00.
The global node ID of the user or organization acting as sponsor (e.g., 'U_kgDOABCDEF'). Required if sponsor_login is not provided.
Whether the sponsorship is recurring (true) or one-time (false). Note: one-time payments currently have a known bug in the GitHub API and may not work as expected.
Privacy level for GitHub sponsorships
The username of the sponsoring user or organization. Required if sponsor_id is not provided.
The global node ID of the user or organization to sponsor (e.g., 'U_kgDOMNOPQR'). Required if sponsorable_login is not provided.
The username of the user or organization to sponsor. Required if sponsorable_id is not provided.
A unique identifier for the client performing the mutation. Used to ensure idempotency of mutations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_SPONSORS_TIERTool to create a new payment tier for your GitHub Sponsors profile using GraphQL. Use when you need to add a new sponsorship tier with a specific monthly price and description. The amount is specified in dollars and will be converted to cents automatically.
Input parameters
The monthly sponsorship amount in dollars (USD). This value will be converted to cents internally (e.g., 5 for $5/month becomes 500 cents, 500 for $500/month becomes 50000 cents). Minimum is $1.
A detailed description of what this sponsorship tier provides. Explain the benefits and perks sponsors will receive at this level. This is a required field.
The global node ID of the user or organization who will receive sponsorships for this tier (e.g., 'U_kgDOABCDEF' for users, 'O_kgDOGHIJKL' for organizations). Use the get_viewer_graphql_id action to fetch your own ID.
A unique identifier for the client performing the mutation. Used to ensure idempotency of mutations and track request origin.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_UPDATE_ORG_SECRET_WITH_LIB_SODIUMCreates or updates a Dependabot organization secret, requiring the secret value to be pre-encrypted with LibSodium using the organization's public key obtained from the 'Get an organization public key' endpoint.
Input parameters
The organization name (case-insensitive).
ID of the Dependabot public key used for encryption (retrieved from 'Get an organization public key for Dependabot' endpoint: GET /orgs/{org}/dependabot/secrets/public-key). Required if `encrypted_value` is provided.
Secret visibility: `all` (all repositories), `private` (private repositories), or `selected` (specific repositories designated by `selected_repository_ids`).
The secret name (case-insensitive and unique within the organization).
Value of the secret, encrypted using \[LibSodium\](https://libsodium.gitbook.io/doc/bindings_for_other_languages) and the organization's Dependabot public key (obtained from the 'Get an organization public key for Dependabot' endpoint: GET /orgs/{org}/dependabot/secrets/public-key). Required to create or update the secret's value.
List of repository IDs that can access the secret; required and used only when `visibility` is `selected`.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_USER_LISTTool to create a new user list on GitHub. Use when you need to organize and group GitHub users for easier tracking and management.
Input parameters
The name of the user list to create.
A description for the user list to provide context about its purpose.
A unique identifier for the client performing the mutation. This can be used to track the request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_CREATE_VIEW_FOR_USER_PROJECTTool to create a new view in a user-owned GitHub project (Projects V2). Use when you need to add a customized view with specific layout, filters, and visible fields to organize project items. Note: This action works with GitHub Projects V2. The view can be configured with different layouts (table, board, roadmap) and optional filters. The visible_fields parameter is not applicable to roadmap layouts.
Input parameters
The name of the view to be created.
The filter query for the view. See GitHub's filtering projects documentation for syntax details.
The layout type for the view. Options are 'table', 'board', or 'roadmap'.
The unique identifier of the user who owns the project. This can be the username or user login.
The project's number as displayed in the project URL.
List of field IDs that should be visible in the view. Not applicable to roadmap layout. If not provided, default visible fields will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DECLINE_A_REPOSITORY_INVITATIONDeclines a specific, pending repository invitation for the authenticated user, identified by its `invitation_id`.
Input parameters
Identifier of the pending repository invitation to decline; obtained by listing the user's pending invitations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_ACCESS_RESTRICTIONSRemoves all user, team, and app-based access restrictions from a protected branch.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The account owner of the repository (username or organization name). This field is not case-sensitive.
The name of the branch from which to remove access restrictions. Wildcard characters are not supported; for wildcard usage, refer to the GitHub GraphQL API.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_ADMIN_BRANCH_PROTECTIONRemoves admin enforcement from a protected branch (branch name cannot contain wildcard characters) in a repository.
Input parameters
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
The name of the branch. Cannot contain wildcard characters.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_A_FILEDeletes a file by path from a GitHub repository. The file's blob SHA is automatically fetched if not provided.
Input parameters
Blob SHA of the file being deleted. Optional - if not provided, it will be automatically fetched from the file at the given path.
Path to the file to be deleted within the repository.
The name of the repository, without the `.git` extension (not case-sensitive).
The account owner of the repository (not case-sensitive).
Branch from which the file will be deleted; defaults to the repository's default branch.
Commit message for the deletion.
Name of the commit author for the deletion; defaults to the committer's name.
Email address of the commit author for the deletion; defaults to the committer's email.
Name of the user committing the deletion; defaults to the authenticated user's name.
Email address of the user committing the deletion; defaults to the authenticated user's email.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_A_PACKAGE_VERSION_FOR_THE_AUTHENTICATED_USERDeletes an existing package version associated with the authenticated user.
Input parameters
The unique name of the package.
Type of the package. E.g., `maven` for GitHub Gradle registry, `container` for `ghcr.io` images. The `docker` type covers images from `docker.pkg.github.com` (including migrated ones).
The unique numeric identifier of the specific package version to be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_APP_AUTHORIZATIONDeletes an OAuth application grant for a user, which revokes ALL OAuth tokens and their associated authorizations for the application. This endpoint is only accessible to OAuth App owners and requires Basic Authentication using the OAuth App's client_id and client_secret.
Input parameters
The client ID of your OAuth App. This must be YOUR OAuth App that you own, as this endpoint requires the app's client_secret for authentication.
An OAuth access token that was issued by your OAuth App (specified by client_id). Providing this token will revoke ALL tokens for that user's grant, not just this single token.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_APP_TOKENRevokes a single OAuth access token for an OAuth App or GitHub App with OAuth authorization. IMPORTANT: This endpoint requires Basic Authentication using the OAuth App's client_id as username and client_secret as password. It CANNOT be called with personal access tokens, GitHub App installation tokens, or any other token type. You must be the OAuth App owner to use this endpoint.
Input parameters
The client ID of the OAuth App or GitHub App with OAuth authorization.
The OAuth access token to be revoked. Must be a token issued by this OAuth App.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_A_REFERENCEDeletes a Git reference from a repository; 'ref' must be fully qualified (e.g., 'refs/heads/branch' or 'refs/tags/tag').
Input parameters
The Git reference to delete. Accepts multiple formats: 'refs/heads/branch-name', 'heads/branch-name', or just 'branch-name' for branches; 'refs/tags/tag-name' or 'tags/tag-name' for tags. Simple branch names are automatically prefixed with 'heads/'.
The name of the repository, without the `.git` extension. This name is not case sensitive.
The account owner of the repository. This name is not case sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_A_RELEASEPermanently deletes a specific release, its assets, and potentially its associated Git tag from a repository.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The account owner of the repository, typically a username or organization name. This field is not case-sensitive.
The unique numerical identifier (ID) of the release to be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_A_RELEASE_ASSETDeletes a specific release asset from a GitHub repository; this action is idempotent.
Input parameters
The name of the repository, without the `.git` extension; not case-sensitive.
The account owner of the repository (username or organization); not case-sensitive.
The unique identifier of the release asset to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_A_RELEASE_REACTIONDeletes a reaction from a GitHub release, provided the repository, release, and reaction exist.
Input parameters
The name of the repository, without the `.git` extension (case-insensitive).
The account owner of the repository (case-insensitive).
Unique identifier of the release.
Unique identifier of the reaction to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_A_REPOSITORYPermanently deletes the specified repository; this is a destructive, irreversible action that requires admin privileges for the repository.
Input parameters
The name of the repository, without the `.git` extension; case-insensitive.
The account owner of the repository (user or organization); case-insensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_A_REPOSITORY_INVITATIONDeletes an active repository invitation, permanently revoking a user's access to collaborate on the specified repository.
Input parameters
The name of the repository, without the `.git` extension. This field is case-insensitive.
The username or organization name that owns the repository. This field is case-insensitive.
The unique numerical identifier of the repository invitation to be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_A_REPOSITORY_RULESETPermanently deletes a repository ruleset.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username of the account that owns the repository. This field is not case-sensitive.
The unique identifier (ID) of the ruleset to be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_A_REPOSITORY_SECRETDeletes a named GitHub Actions secret from a specified repository; this operation is destructive and idempotent, and requires the repository to exist.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The account owner of the repository. This is typically the username or organization name and is not case-sensitive.
The name of the secret to delete. This refers to a secret used in GitHub Actions.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_A_REPOSITORY_SUBSCRIPTIONDeletes the authenticated user's subscription to a specified repository if it exists, effectively 'unwatching' it.
Input parameters
The name of the repository, without the `.git` extension. This name is not case-sensitive.
The account owner of the repository (e.g., a GitHub username or organization name). This name is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_A_REPOSITORY_VARIABLEDeletes a named variable (e.g., for GitHub Actions workflows) from a repository; the repository and the variable must already exist.
Input parameters
The name of the repository variable to delete.
The name of the repository, without the `.git` extension. This name is not case-sensitive.
The account owner of the repository. This name is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_A_REPOSITORY_WEBHOOKDeletes a specific webhook from a repository.
Input parameters
The name of the repository, without the `.git` extension. This name is not case sensitive.
The account owner of the repository. This name is not case sensitive.
The unique identifier of the webhook. This ID can be found in the `X-GitHub-Hook-ID` header of a webhook delivery.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_A_REVIEW_COMMENT_FOR_A_PULL_REQUESTDeletes a specific pull request review comment.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
The unique numerical identifier of the pull request review comment to be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_ARTIFACTDeletes a GitHub artifact by its ID within a repository, typically resulting in an empty response (HTTP 204 No Content) on success.
Input parameters
Name of the repository, without the `.git` extension; not case-sensitive.
Account owner of the repository (user or organization); not case-sensitive.
Unique ID of the artifact to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_A_SECRET_FOR_THE_AUTHENTICATED_USERDeletes an existing Codespaces secret for the authenticated user by `secret_name`. This is a destructive and irreversible operation. Returns 404 if the secret does not exist.
Input parameters
Name of the Codespaces secret to delete. Case-sensitive; allows alphanumeric characters or underscores; must not start with `GITHUB_` or contain spaces.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_A_SELF_HOSTED_RUNNER_FROM_AN_ORGANIZATIONForces the removal of a self-hosted runner from a GitHub organization. This endpoint can be used to completely remove the runner when the machine you were using no longer exists. The runner will be immediately disconnected from GitHub Actions. Requires admin:org scope and organization admin access. Returns 204 No Content on successful deletion.
Input parameters
Organization name (not case-sensitive).
Unique ID of the self-hosted runner to remove (obtainable by listing organization runners).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_A_SELF_HOSTED_RUNNER_FROM_A_REPOSITORYRemoves a specific self-hosted runner (by `runner_id`) from a repository, if registered there; this is idempotent.
Input parameters
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
Unique identifier of the self-hosted runner.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_A_TAG_PROTECTION_STATE_FOR_A_REPOSITORYDEPRECATED: This API was sunset on August 30, 2024. Use GITHUB_DELETE_A_REPOSITORY_RULESET instead to manage tag protection rules via repository rulesets.
Input parameters
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
The unique identifier of the tag protection to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_A_TEAMDeletes a team (and any child teams) from an organization.
Input parameters
The organization's unique identifier (case-insensitive).
The team's URL-friendly slug.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_A_THREAD_SUBSCRIPTIONCall this to mute a specific notification thread by deleting the user's subscription; notifications may still occur if the user is @mentioned, comments, or due to repository watch settings.
Input parameters
The unique identifier of the notification thread. This ID is obtained from other API calls, such as when listing notifications (e.g., via the `GET /notifications` endpoint). Ensure this ID refers to an active thread to which the user is currently subscribed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_AUTOLINK_REFERENCEDeletes a specific autolink reference (which automatically links external resource IDs like JIRA-123 to URLs) from the specified repository.
Input parameters
The name of the repository, without the `.git` extension. This is not case-sensitive.
The username or organization name that owns the repository. This is not case-sensitive.
The unique numerical identifier of the autolink reference to be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_A_WORKFLOW_RUNDeletes a specific workflow run from a repository.
Input parameters
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
The unique identifier of the workflow run.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_BRANCH_PROTECTIONRemoves all protection rules from a specific branch in a GitHub repository; the branch must currently have protection rules enabled.
Input parameters
The name of the repository, without the `.git` extension. Not case sensitive.
The account owner of the repository. Not case sensitive.
The name of the branch. Wildcard characters are not supported for this REST API endpoint; use the GitHub GraphQL API for wildcard support.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_CODE_SCANNING_ANALYSISDeletes a specific code scanning analysis by its ID from a repository; `confirm_delete` must be `true` if it's the last analysis of its type for a given tool and reference to prevent data loss.
Input parameters
Name of the repository without the `.git` extension (not case sensitive).
Account owner of the repository (not case sensitive).
Unique identifier of the code scanning analysis to delete, typically obtained by listing analyses.
Pass the string `true` to confirm deletion when this is the last analysis of its type for a specific tool and reference. Required to avoid a 400 error when deleting the final analysis in a set.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_CODESPACEDeletes a specific codespace owned by the authenticated user; this is a destructive action and the codespace must exist.
Input parameters
The unique name of the codespace to be deleted. This can be the system-generated name (e.g., 'monalisa-octocat-g4v9wxj96hp') or a user-defined display name if it's unique for the user.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_COMMIT_COMMENTDeletes a specific commit comment, identified by its `comment_id`, from the specified repository; the comment must exist.
Input parameters
The name of the repository, excluding the `.git` extension. This value is not case-sensitive.
The username or organization name that owns the repository. This value is not case-sensitive.
The unique numerical identifier of the commit comment to be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_COMMIT_COMMENT_REACTIONDeletes a reaction from a commit comment in a GitHub repository.
Input parameters
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
The unique identifier of the commit comment from which the reaction will be deleted.
The unique identifier of the reaction to be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_COMMIT_SIGNATURE_PROTECTIONDisables GPG commit signature protection for a specific branch in a GitHub repository, meaning commits pushed to this branch no longer require GPG signing.
Input parameters
The name of the repository, without the `.git` extension. The name is not case-sensitive.
The account owner of the repository. This is typically the username of the owner (for personal repositories) or the organization name (for organization-owned repositories). The name is not case-sensitive.
The name of the branch for which commit signature protection will be disabled. Wildcard characters are not supported in the branch name. To use wildcards, refer to the GitHub GraphQL API.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_CUSTOM_ORGANIZATION_ROLEDeletes a custom organization role (which should not be actively assigned) by its ID; a 204 No Content response indicates success.
Input parameters
The organization name (not case-sensitive).
Unique ID of the custom role to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_DEPENDEBOT_SECRET_BY_NAMEDeletes a specific Dependabot secret, identified by its name, from a given repository if both the repository and secret exist.
Input parameters
The name of the repository without the `.git` extension. This field is not case-sensitive.
The account owner of the repository (e.g., username or organization name). This field is not case-sensitive.
The name of the Dependabot secret to delete. Secret names are case-sensitive and can only contain alphanumeric characters (\[A-Z\], \[a-z\], \[0-9\]) or underscores (_); spaces are not allowed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_DEPLOY_KEYDeletes a specific deploy key from a repository; to change a key's properties or access scope, the existing key must be deleted and a new one created.
Input parameters
The name of the repository, without the `.git` extension. This name is not case sensitive.
The account owner of the repository. This name is not case sensitive.
The unique identifier (ID) of the deploy key to be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_DEPLOYMENTPermanently deletes a specified *inactive* deployment from a repository.
Input parameters
Repository name, without the `.git` extension (case-insensitive).
Username of the account owning the repository (case-insensitive).
Unique identifier of the deployment to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_DEPLOYMENT_BRANCH_POLICYDeletes a specific deployment branch or tag policy, identified by its ID, from a given environment within a repository.
Input parameters
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
The unique identifier of the branch policy.
The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_DISCUSSIONDeletes a specific team discussion, identified by its number, from an organization's team.
Input parameters
Case-insensitive name of the organization.
URL-friendly version (slug) of the team name.
The unique number identifying the discussion to be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_DISCUSSION_COMMENTDeletes a specific comment from an existing team discussion within an organization, provided the specified organization, team, discussion, and comment all exist.
Input parameters
The organization name (not case sensitive).
The slug of the team name (URL-friendly version).
Unique number identifying the comment.
Unique number identifying the discussion.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_EMAIL_ADDRESSSends an empty request body to `DELETE /user/emails` to attempt deletion of user email addresses; the API typically requires specific emails, so outcome may vary.
Input parameters
Array of email addresses to delete from the authenticated user account.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_ENVIRONMENTDeletes an existing deployment environment from an existing repository.
Input parameters
The name of the repository, without the `.git` extension. This is not case sensitive.
The username or organization name that owns the repository. This is not case sensitive.
The name of the environment to delete. The name must be URL encoded; for example, slashes (`/`) should be replaced with `%2F`.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_ENVIRONMENT_SECRETDeletes an existing and accessible secret from a specified environment within a GitHub repository, returning an empty dictionary on success or error details otherwise.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
The name of the secret to be deleted. GitHub stores and processes secret names as uppercase (e.g., `my_secret` becomes `MY_SECRET`).
The name of the environment from which the secret will be deleted. This name must be URL-encoded if it contains special characters (e.g., slashes `/` should be replaced with `%2F`).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_ENVIRONMENT_VARIABLEDeletes a named environment variable from a specified, existing environment within a GitHub repository.
Input parameters
The name of the environment variable to delete.
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
The name of the environment. Must be URL-encoded if it contains special characters (e.g., slashes `/` should be `%2F`).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_GISTPermanently deletes an existing GitHub gist, specified by its `gist_id`; this action is destructive and cannot be undone.
Input parameters
The unique identifier of the gist to be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_GIST_COMMENTDeletes a specific comment from a GitHub Gist using its `gist_id` and `comment_id`.
Input parameters
The unique identifier of the Gist from which the comment will be deleted.
The unique identifier of the comment to be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_GITHUB_ACTIONS_CACHE_BY_IDDeletes a specific GitHub Actions cache from a repository using its unique `cache_id`.
Input parameters
The name of the repository, without the `.git` extension.
The username or organization name that owns the repository.
The unique ID of the GitHub Actions cache to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_GITHUB_PAGES_SITEDeletes the GitHub Pages site for the specified repository; completes without error if no site is currently enabled.
Input parameters
The name of the repository, without the `.git` extension. This name is not case-sensitive.
The account owner of the repository (e.g., a user or organization). This name is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_ISSUE_COMMENTPermanently deletes a specific comment by its ID from an issue or pull request, if the repository exists and the comment ID is valid.
Input parameters
Name of the repository, without the `.git` extension (case-insensitive).
Username of the account owning the repository (case-insensitive).
Unique identifier of the comment to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_ISSUE_COMMENT_REACTIONDeletes a reaction from an issue comment in a repository; the repository, comment, and reaction must exist.
Input parameters
The name of the repository, without the `.git` extension. This is not case-sensitive.
The username of the account that owns the repository. This is not case-sensitive.
The unique numeric identifier for the issue comment from which the reaction will be deleted.
The unique numeric identifier for the reaction to be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_ISSUE_REACTIONPermanently removes a specific reaction from an issue in a GitHub repository.
Input parameters
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
The unique identifier of the reaction to be deleted.
The unique number identifying the issue from which the reaction will be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_LABELPermanently removes an existing label from a repository.
Input parameters
The name of the label to delete. Label names are case-insensitive. If the label name contains spaces or special characters, ensure it is correctly URL-encoded (e.g., 'help wanted' becomes 'help%20wanted').
REQUIRED. The name of the repository, without the `.git` extension. Must be provided together with 'owner' to identify the repository (e.g., for 'github.com/octocat/Hello-World', repo is 'Hello-World'). This field is not case-sensitive.
REQUIRED. The username or organization name that owns the repository. GitHub repositories are identified by owner/repo (e.g., 'octocat/Hello-World'), so both 'owner' and 'repo' must be provided together. This field is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_MILESTONEDeletes the specified milestone if it exists; this operation is idempotent, typically returning a 404 if the milestone is not found or already deleted.
Input parameters
The name of the repository, without the `.git` extension. This name is not case-sensitive.
The username or organization name that owns the repository. This name is not case-sensitive.
The unique number that identifies the milestone to be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_ORGANIZATIONDeletes a GitHub organization and its repositories; this is a destructive action and the organization name will be unavailable for reuse for approximately 90 days.
Input parameters
The unique name of the organization to be deleted. This name is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_ORGANIZATION_SECRETPermanently deletes a secret from a GitHub organization, making it inaccessible to GitHub Actions workflows or other tools.
Input parameters
The name of the organization. This name is not case-sensitive.
The name of the secret to be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_ORGANIZATION_VARIABLEDeletes a named GitHub Actions variable from a specified organization.
Input parameters
The name of the organization. This parameter is not case-sensitive.
The name of the organization variable to delete. This parameter is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_ORGANIZATION_WEBHOOKDeletes a specific webhook, identified by `hook_id`, from an existing organization.
Input parameters
The name of the organization. This field is not case-sensitive.
The unique identifier of the webhook. This ID can be retrieved from the `X-GitHub-Hook-ID` header in a webhook delivery or by listing organization webhooks.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_ORG_CODESPACEPermanently deletes a specific codespace belonging to a member of the specified organization.
Input parameters
The organization's name (case-insensitive).
GitHub username of the user owning the codespace.
Unique name of the codespace.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_ORG_PACKAGEDeletes a specific package in an organization; cannot delete public packages with over 5,000 downloads.
Input parameters
Name of the organization owning the package (not case-sensitive).
Unique name of the package to be deleted.
Type of the package to be deleted. Packages in GitHub's Gradle registry have type `maven`. Docker images in GitHub's Container registry (`ghcr.io`) have type `container`. Use type `docker` for images previously in GitHub's Docker registry (`docker.pkg.github.com`), even if migrated to the Container registry.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_PACKAGEPermanently deletes a specific package owned by the authenticated user; public packages downloaded over 5,000 times cannot be deleted via this API.
Input parameters
The unique name of the package to delete. For npm: supports scoped packages like '@scope/name'. For maven: use format 'com.example.package'. For container/docker: use image name like 'my-app'. The name must match exactly as it appears in the GitHub Packages registry.
The type of package to delete. Supported types: 'npm' (Node.js packages), 'maven' (Java/Gradle packages), 'rubygems' (Ruby gems), 'docker' (legacy Docker images from docker.pkg.github.com), 'nuget' (.NET packages), 'container' (Docker images from ghcr.io). Note: GitHub Gradle packages use 'maven' type; ghcr.io images use 'container' type.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_PACKAGE_VERSIONTool to delete a package version using GitHub GraphQL API. Use when you need to remove a specific version of a package by its global node ID.
Input parameters
A unique identifier for the client performing the mutation. Used to ensure idempotency of mutations.
The global node ID of the package version to delete (e.g., 'MDEyOlBhY2thZ2VWZXJzaW9uMQ=='). This is the GraphQL ID, not the numeric REST API ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_PACKAGE_VERSION_FOR_AN_ORGANIZATIONDeletes a specific package version within an organization; requires admin permissions for packages with over 5,000 downloads.
Input parameters
Organization name (case-insensitive).
Name of the package.
Package ecosystem. Notes: - `maven`: For GitHub's Gradle registry packages. - `container`: For Docker images in GitHub's Container registry (ghcr.io). - `docker`: For images originally in GitHub's Docker registry (docker.pkg.github.com), including migrated ones.
Unique ID of the package version to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_PACKAGE_VERSION_FOR_A_USERPermanently and irreversibly deletes a specific version of a package owned by the specified user.
Input parameters
The GitHub username of the account that owns the package.
The name of the package to which the version belongs.
The type of the package. Supported types include npm, maven, rubygems, docker, nuget, and container. Packages in GitHub's Gradle registry use the `maven` type. Docker images in GitHub's Container registry (ghcr.io) use the `container` type. The `docker` type can be used for images previously in GitHub's Docker registry (docker.pkg.github.com), even if migrated.
The unique identifier of the package version to be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_PENDING_REVIEWDeletes a pending (unsubmitted) review from a pull request; this is only possible if the review has not yet been submitted.
Input parameters
The name of the repository, without the `.git` extension. This name is not case-sensitive.
The account owner of the repository. This name is not case-sensitive.
The unique identifier of the pending review to be deleted.
The number that identifies the pull request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_PROJECTDeletes the specified GitHub project (Projects V2) using the GraphQL API. Note: This action uses GitHub's Projects V2 GraphQL API. The legacy Projects (classic) REST API was sunset on April 1, 2025 and is no longer available. The project is permanently deleted and cannot be recovered. The user must have admin permissions for the project to delete it.
Input parameters
The unique GraphQL node ID of the project to be deleted (e.g., 'PVT_kwDOBcMqx84ABdPx'). This is returned from project creation or listing operations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_PROJECT_CARDDeletes a project card from a GitHub 'Project (classic)'; this operation is idempotent. DEPRECATION NOTICE: GitHub Classic Projects (V1) and its REST API were sunset on April 1, 2025. This action may return a 404 error on GitHub.com. For new projects, use GitHub Projects V2 which uses the GraphQL API instead. See: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/
Input parameters
The unique numerical identifier of the project card to be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_PROJECT_COLUMNDeletes a project field (column) from a GitHub Projects V2 project using the GraphQL API. IMPORTANT: GitHub Classic Projects REST API was sunset on April 1, 2025. This action now uses the GitHub Projects V2 GraphQL API with the deleteProjectV2Field mutation. Note: The built-in Status field cannot be deleted as it is a core field in GitHub Projects V2. Only custom fields can be deleted.
Input parameters
The node ID of the project field to be deleted. This is a GraphQL node ID (e.g., 'PVTF_...').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_PROJECT_ITEM_FOR_USERTool to delete a project item for a user in GitHub Projects V2. Use when you need to remove an item from a user's project. Requires the project item's GraphQL node ID (starts with 'PVTI_'). Uses the GitHub GraphQL API deleteProjectV2Item mutation.
Input parameters
The GraphQL node ID of the project item to delete (e.g. 'PVTI_lADOBCxhzs4A...').
The handle for the GitHub user account.
The project's number.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_PULL_REQUEST_COMMENT_REACTIONDeletes a specific reaction from a pull request review comment, provided the comment and reaction exist on that comment within the specified repository.
Input parameters
Name of the repository, without the `.git` extension; not case-sensitive.
Account owner (username or organization) of the repository; not case-sensitive.
Unique ID of the pull request review comment.
Unique ID of the reaction to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_PULL_REQUEST_REVIEW_PROTECTIONDisables the requirement for pull request reviews before merging for a specific, existing branch in an existing repository; this action is idempotent and will succeed even if the protection is not currently enabled.
Input parameters
Name of the repository, without the `.git` extension (not case-sensitive).
Username or organization name of the repository owner (not case-sensitive).
Name of the branch to remove pull request review protection from (wildcards not supported; use GraphQL API for wildcards).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_REPO_CODESPACE_SECRET_BY_NAMEDeletes a specific Codespace secret from a repository by its name; this action is idempotent and will succeed even if the secret doesn't exist.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username of the account or the name of the organization that owns the repository. This field is not case-sensitive.
The name of the Codespace secret to be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_SOCIAL_ACCOUNTS_FOR_THE_AUTHENTICATED_USERDeletes currently linked social media account URLs from the authenticated user's GitHub profile.
Input parameters
Absolute URLs of the social media profiles to be unlinked from the GitHub profile.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_TEAM_DISCUSSION_COMMENT_REACTIONDeletes a reaction from a team discussion comment, given the organization name, team slug, discussion number, comment number, and reaction ID.
Input parameters
The organization name. The name is not case sensitive.
The slug of the team name (URL-friendly version).
The unique identifier of the reaction to be deleted.
The number that uniquely identifies the comment within the discussion.
The number that uniquely identifies the discussion.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_TEAM_DISCUSSION_REACTIONPermanently deletes a specific reaction from a team discussion within an organization.
Input parameters
The organization name. This name is not case sensitive.
The slug of the team name, which is a URL-friendly version of the team name.
The unique identifier of the reaction to be deleted.
The unique number identifying the specific discussion within the team.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_USER_LISTTool to delete a GitHub user list using GraphQL. Use when you need to remove a user list from a GitHub account.
Input parameters
The ID of the user list to delete. This is a GitHub global node ID for the list.
A unique identifier for the client performing the mutation. Used to track requests.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_USER_PACKAGEDeletes a package owned by the specified user, requiring admin permissions for the authenticated user; deletion of public packages with over 5,000 downloads may require GitHub support.
Input parameters
The GitHub username of the account that owns the package.
The unique name of the package to be deleted.
Ecosystem of the package. Packages in GitHub's Gradle registry use `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) use `container`. The `docker` type can find images from the old Docker registry (`docker.pkg.github.com`), even if migrated.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DELETE_WORKFLOW_RUN_LOGSDeletes all logs for a specific workflow run in a GitHub repository, provided the repository and run exist.
Input parameters
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
The unique identifier of the workflow run.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DISABLE_A_CUSTOM_PROTECTION_RULE_FOR_AN_ENVIRONMENTDisables a specific, currently active custom deployment protection rule for an existing environment within a GitHub repository.
Input parameters
The name of the repository (without the `.git` extension). This name is not case sensitive.
The account owner of the repository (e.g., a user or organization). This name is not case sensitive.
The name of the environment. This name must be URL encoded; for example, any slashes (`/`) in the name must be replaced with `%2F`.
The unique integer identifier of the custom deployment protection rule to be disabled.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DISABLE_A_WORKFLOWDisables a specified workflow (by ID or filename) in a given GitHub repository, preventing new automatic triggers; any in-progress runs will continue.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The account owner of the repository (username or organization name). This field is not case-sensitive.
The ID of the workflow or the workflow's file name (e.g., `main.yml` or `ci.yaml`). You can obtain the workflow ID by listing workflows in a repository.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DISABLE_PRIVATE_VULN_REPORTING_FOR_REPODisables private vulnerability reporting for an existing GitHub repository, preventing direct private vulnerability reports to maintainers via GitHub's interface for this repository.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The account owner of the repository (e.g., a GitHub username or organization name). This field is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DISABLE_REPOSITORY_ACTIONS_IN_ORGRemoves a repository from the list of selected repositories enabled for GitHub Actions in an organization. Only works when the organization's `enabled_repositories` policy is set to `selected`. Requires admin:org scope.
Input parameters
The GitHub organization name (not case-sensitive).
The unique identifier of the repository.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DISMISS_A_REVIEW_FOR_A_PULL_REQUESTDismisses an APPROVED or CHANGES_REQUESTED review on a pull request with a mandatory explanatory message. IMPORTANT: Only reviews in APPROVED or CHANGES_REQUESTED state can be dismissed. Reviews in COMMENTED, PENDING, or already DISMISSED state will return a 422 error. To dismiss a review on a protected branch, you must be a repository admin or be authorized to dismiss pull request reviews.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The event type for dismissing the review. Must be set to DISMISS.
The username or organization name that owns the repository. This field is not case-sensitive.
The reason for dismissing the review. This is a required field.
The unique identifier for the review to be dismissed. The review must be in APPROVED or CHANGES_REQUESTED state.
The unique number identifying the pull request within the repository.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DOWNLOAD_AN_ARTIFACTDownloads a GitHub Actions workflow artifact as a ZIP file. Returns the artifact as a downloadable file. Use GITHUB_LIST_ARTIFACTS_FOR_A_REPOSITORY or GITHUB_LIST_WORKFLOW_RUN_ARTIFACTS to get valid artifact IDs first.
Input parameters
Repository name, without the `.git` extension (case-insensitive).
Username or organization name of the repository owner (case-insensitive).
Unique numeric identifier of the artifact. Obtain from GITHUB_LIST_ARTIFACTS_FOR_A_REPOSITORY or GITHUB_LIST_WORKFLOW_RUN_ARTIFACTS actions.
Archive format for the download. GitHub API only supports 'zip'. Defaults to 'zip'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DOWNLOAD_A_REPOSITORY_ARCHIVE_TARDownloads a repository's source code as a tarball (.tar.gz) archive for a specific Git reference, if the repository is accessible.
Input parameters
A Git reference (e.g., branch name, tag name, or commit SHA) that points to the specific version of the repository content to be downloaded as a tarball archive. For example, `main` for the main branch, `v1.0.0` for a tag, or a full commit SHA.
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DOWNLOAD_A_REPOSITORY_ARCHIVE_ZIPDownloads a repository's source code as a ZIP archive for a specific Git reference (branch, tag, or commit SHA). IMPORTANT SIZE LIMITATION: This action may fail with 'payload too large' errors for large repositories due to platform size restrictions. If you encounter size limit issues, consider these alternatives: - Use GITHUB_GET_REPOSITORY_CONTENT to fetch specific files or directories (also lists directory contents) - Clone the repository using git if you need the full codebase Best suited for: small to medium repositories, downloading specific tagged releases, or quick code inspection.
Input parameters
The Git reference for the archive. This can be a branch name, a tag name, or a commit SHA.
The name of the repository, without the `.git` extension. This is not case-sensitive.
The username of the account that owns the repository. This is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DOWNLOAD_JOB_LOGS_FOR_A_WORKFLOW_RUNDownloads logs for a specific job in a GitHub Actions workflow run, contingent on the repository's existence and the job ID being valid and having produced logs.
Input parameters
The name of the repository, without the `.git` extension. This name is not case-sensitive.
The account owner of the repository (e.g., user or organization). This name is not case-sensitive.
The unique identifier of the job for which to download logs. You can obtain this from the 'List jobs for a workflow run' endpoint.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DOWNLOAD_WORKFLOW_RUN_ATTEMPT_LOGSDownloads a ZIP archive of logs for a specific workflow run attempt. Returns a downloadable ZIP file containing logs for all jobs and steps in the workflow run.
Input parameters
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
The unique identifier of the workflow run.
The attempt number of the workflow run.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_DOWNLOAD_WORKFLOW_RUN_LOGSDownloads logs for a specific GitHub Actions workflow run as a ZIP archive containing log files for each job in the workflow.
Input parameters
The name of the repository (e.g., 'Spoon-Knife') without the `.git` extension. This name is not case-sensitive.
The account owner of the repository (e.g., 'octocat'). This name is not case-sensitive.
The unique identifier of the workflow run (e.g., 12345).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ENABLE_A_WORKFLOWReactivates a currently disabled GitHub Actions workflow within a repository using its workflow ID or filename.
Input parameters
The name of the repository, without the `.git` extension. This value is not case-sensitive.
The username or organization name that owns the repository. This value is not case-sensitive.
The ID of the workflow to be enabled. You can provide either the numeric workflow ID (e.g., 30433642) or the workflow filename (e.g., 'ci.yaml', 'data.yml').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ENABLE_GITHUB_ACTIONS_IN_SELECTED_REPOSITORIESSets the specific repositories that can use GitHub Actions within an organization by replacing the current list; only applies if the organization's Actions policy is 'selected repositories'.
Input parameters
Name of the GitHub organization (case-insensitive).
List of unique repository IDs for which GitHub Actions will be enabled. This list completely replaces the current selection of repositories.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ENABLE_PRIVATE_VULN_REPORTING_FOR_REPOEnables private vulnerability reporting for a repository, allowing security researchers to privately submit vulnerability reports to maintainers.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The account owner of the repository. This is typically the username or organization name and is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ENABLE_REPO_FOR_GITHUB_ACTIONSAdds a repository to the list of selected repositories enabled for GitHub Actions in an organization. Requires the organization's 'enabled_repositories' policy to be set to 'selected'.
Input parameters
The name of the GitHub organization. This name is not case-sensitive.
The unique numerical identifier of the GitHub repository.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ENCRYPT_AND_UPDATE_DEV_SECRETCreates or updates a repository's development environment secret using an `encrypted_value` and its corresponding `key_id`; the secret must be pre-encrypted with the repository's Codespaces public key.
Input parameters
The name of the repository without the `.git` extension. This name is not case-sensitive.
The account owner of the repository. This name is not case-sensitive.
ID of the public key (retrieved from the GitHub API's 'Get a repository public key for Codespaces' endpoint: `GET /repos/{owner}/{repo}/codespaces/secrets/public-key`) used to encrypt the secret's value. If not provided, it will be fetched automatically.
The name of the development environment secret.
The plaintext value for your secret. This will be automatically encrypted using the repository's Codespaces public key before being sent to GitHub. If you already have an encrypted value, use the encrypted_value parameter instead.
Value for your secret, already encrypted using the public key retrieved from the GitHub API's 'Get a repository public key for Codespaces' endpoint (`GET /repos/{owner}/{repo}/codespaces/secrets/public-key`). Use this if you have pre-encrypted the value yourself.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_ENCRYPT_ORG_DEV_ENV_SECRETCreates or updates an organization's GitHub Codespaces secret using an encrypted value and its corresponding public key ID.
Input parameters
The GitHub organization name (case-insensitive).
ID of the public key (from GET /orgs/{org}/codespaces/secrets/public-key) used to encrypt the secret's value. If not provided, it will be fetched automatically when encrypting.
Visibility of the secret. 'selected' requires `selected_repository_ids`.
Name of the secret to create or update.
The plaintext value for your secret. This will be automatically encrypted using the organization's Codespaces public key before being sent to GitHub. If you already have an encrypted value, use the encrypted_value parameter instead.
Encrypted secret value, using the public key from 'Get an organization public key' (GET /orgs/{org}/codespaces/secrets/public-key). Use this if you have pre-encrypted the value yourself. If not provided and secret_value is given, encryption will be done automatically.
Repository IDs that can access the secret; required if visibility is 'selected'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_EXPORT_A_CODESPACE_FOR_THE_AUTHENTICATED_USERTriggers an export of a user's specified codespace, automatically stopping it if active, and returns its export status and download URL.
Input parameters
Unique name of the codespace to be exported.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_EXPORT_SBOM_FOR_REPOExports the software bill of materials (SBOM) in SPDX JSON format for a repository, if its dependency graph is enabled and it has at least one commit.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_FIND_PULL_REQUESTSPrimary tool to find and search pull requests. Supports filtering by repository, author, state, labels, and merge status, and returns structured PR data for reliable use in workflows. GitHub search results are capped at ~1000 total items; narrow filters when totals approach this limit. `created_since`/`updated_since` filter on creation/update timestamps, not `merged_at`; apply merge-date filtering client-side.
Input parameters
Page number of results to fetch.
Filter by specific repository. Can be provided in 'owner/repo' format (e.g., 'facebook/react'), or as just the repo name when used with the owner parameter. When owner and repo are both provided and have the same value, they are combined as 'owner/repo'. When omitted along with owner, search scope is determined by for_authenticated_user flag. The repository must exist and be accessible with your token. Prefer 'owner/repo' format; bare repo name without the `owner` parameter causes invalid repository format errors.
Field to sort results by. Set explicitly to 'updated' with `order=desc` when recency matters; default behavior may return best-match relevance ordering instead.
Filter by label name.
Sort order (ascending or descending).
Filter by repository owner (user or organization). Can be used alone to search all repositories for an owner, or combined with repo parameter to specify owner and repo separately. When both owner and repo are provided, the search is scoped to 'owner/repo'. When omitted along with repo, search scope is determined by for_authenticated_user flag. The owner must exist and repositories must be accessible with your token.
Optional search query for PR title, description, or commit messages. Supports GitHub search syntax including label filters (e.g., 'label:bug'), logical operators (AND, OR, NOT), and text search. If not provided, PRs will be listed based on other filter parameters. Type qualifiers (type:pr, is:pr, is:issue, type:issue) are automatically normalized. When using logical operators with qualifiers like labels, the query is automatically grouped for proper parsing. When omitting query, ensure at least one structured filter parameter is provided; passing no query and no filters may cause validation errors. Prefer dedicated parameters (`label`, `state`, `author`) over embedding qualifiers in the query string. Exact title matching is not supported; post-filter on title client-side if needed.
Filter by PR state: 'open', 'closed', or 'all'.
Filter by PR author username. Must be a valid GitHub username (alphanumeric characters and hyphens only, cannot start or end with hyphen). No dots or other special characters allowed.
Filter by PR assignee username. Use '@me' for current user. Must be a valid GitHub username (alphanumeric characters and hyphens only, cannot start or end with hyphen). No dots or other special characters allowed.
Filter by programming language.
Filter by username mentioned in PR. Must be a valid GitHub username (alphanumeric characters and hyphens only, cannot start or end with hyphen). No dots or other special characters allowed.
Number of results per page (maximum 100). GitHub caps total search results at ~1000 items; iterate `page` until results fewer than `per_page` are returned, and add `repo`, `label`, or date filters when totals approach 1000.
Filter by merge status. True for merged PRs, False for unmerged, None for all.
Filter by base branch name.
Filter by head branch name.
Filter PRs created after this date (ISO 8601 format). Provide as UTC ISO 8601 timestamp to avoid off-by-one-day errors at range boundaries. Does not filter on `merged_at`.
Filter PRs updated after this date (ISO 8601 format).
Level of detail in the response. 'minimal' (default) returns an optimized response for AI agents. 'full' returns the complete GitHub API response.
Include private repositories accessible to the authenticated user in search results. When True without repo/owner, searches PRs involving you (author, assignee, mentions, commenter) across all accessible repos. When False without repo/owner, restricts to public repos only. When repo/owner is specified, this flag has no effect on scope. Set to True when searching private repositories; False searches all of GitHub and produces large noisy result sets.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_FIND_REPOSITORIESAI-optimized repository search with smart filtering by language, stars, topics, and ownership. Builds intelligent search queries and returns clean, actionable repository data. Check `incomplete_results` in the response — when true, results are non-exhaustive. Search endpoints are rate-limited to ~30 requests/minute (vs. 5000/hour for general REST); apply backoff on 403/429. Total results are capped at ~1000 per query regardless of pagination.
Input parameters
Page number of results to fetch.
Field to sort results by.
Sort order (ascending or descending).
Filter by specific user or organization. Do NOT use this parameter if your 'query' already contains 'user:', 'org:', or 'repo:' qualifiers - they will conflict. Use either 'owner' parameter OR search qualifiers in 'query', not both.
Search query for repository name, description, or README content. Accepts both 'query' and 'q' as parameter names. Supports OR operator for alternatives (e.g., 'bug OR error'). Multi-word phrases in OR expressions are automatically quoted. GitHub limits OR expressions to 6 terms maximum; queries exceeding this limit are truncated. If using GitHub qualifiers like 'repo:', 'user:', or 'org:', they must be properly formatted (e.g., 'repo:owner/name', 'user:username', 'org:orgname'). Note: 'owner:' is not a valid GitHub qualifier; if used, it will be automatically transformed to 'user:'. Must be non-empty; blank strings trigger a 'Search query cannot be empty' validation error.
Filter by repository topic/tag.
Filter by archived status. None means include both.
Filter by programming language.
Number of results per page (maximum 100). GitHub caps total results at ~1000 per query; for exhaustive searches, split by `language`, `topic`, `min_stars`/`max_stars`, or `owner`.
Maximum number of stars the repository should have.
Minimum number of forks the repository should have.
Minimum number of stars the repository should have.
How to handle forks: 'include' (include forks), 'exclude' (exclude forks), 'only' (only forks).
Level of detail in the response. 'minimal' (default) returns an optimized response for AI agents. 'full' returns the complete GitHub API response.
Search only in repositories accessible to the authenticated user (including private repos). Requires token scopes `repo`/`read:org`; sparse results compared to GitHub UI typically indicate insufficient token scopes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_FOLLOW_ORGANIZATION_GRAPHQLTool to follow a GitHub organization using GraphQL. Use when you need to make the authenticated user follow an organization.
Input parameters
The global GraphQL node ID of the organization to follow. Must be a valid organization node ID.
A unique identifier for the client performing the mutation. Used to track requests.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_FOLLOW_USERAllows the authenticated user to follow the GitHub user specified by `username`; this action is idempotent and the user cannot follow themselves.
Input parameters
The GitHub username (handle) of the user to be followed by the authenticated user.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_FOLLOW_USER_GRAPHQLTool to follow a GitHub user using GraphQL. Use when you need to make the authenticated user follow another user.
Input parameters
The global Node ID of the user to follow. Must be a valid GitHub user ID in the format 'MDQ6VXNlcjU4MzIzMQ=='.
A unique identifier for the client performing the mutation. Used to track requests.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_FORCE_CANCEL_WORKFLOW_RUNForcefully cancels a queued or in-progress GitHub Actions workflow run, bypassing conditions like always() that would otherwise continue execution. Only use when the standard cancel endpoint fails. Cannot cancel completed workflow runs. Requires write permissions to the repository.
Input parameters
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
The unique identifier of the workflow run. Note: Only workflow runs with status 'queued' or 'in_progress' can be canceled. Completed workflow runs cannot be canceled.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_FORK_GISTForks a specified public gist, creating a copy under the authenticated user's account.
Input parameters
The unique identifier of the gist to be forked.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GENERATE_RELEASE_NOTESGenerates Markdown release notes content (listing changes, pull requests, and contributors) for a GitHub repository release, customizable via tags and a configuration file.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
The tag name for which the release notes are to be generated. This can be an existing tag or a new tag name.
Specifies the commitish value (e.g., a branch name, tag name, or commit SHA) that will be the target for the release's tag. This is required if the `tag_name` does not reference an existing tag. It is ignored if `tag_name` already exists.
The name of the previous tag to use as the starting point for the release notes. This manually specifies the range of changes to be included. If omitted, GitHub will attempt to automatically determine the previous release.
Specifies a path to a configuration file in the repository (e.g., `.github/release.yml`) containing settings for generating release notes. If unspecified, GitHub looks for a configuration file at ".github/release.yml" or ".github/release.yaml". If no such file is found, default settings are used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_BLOBRetrieves the raw, typically Base64-encoded, content of a file (blob) from a GitHub repository using its SHA hash, if the repository and blob SHA exist.
Input parameters
The name of the repository, without the '.git' extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
The SHA-1 hash of the file (blob) to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_BRANCHRetrieves detailed information for a specified branch within a GitHub repository.
Input parameters
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use \[the GraphQL API\](https://docs.github.com/graphql). If 'HEAD' is provided, it will be resolved to the repository's default branch.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_ACCESS_RESTRICTIONSLists users, teams, and GitHub Apps with push access to a branch; this branch must be protected in repository settings for detailed restrictions, otherwise expect a 404 or empty response.
Input parameters
The name of the repository, without the `.git` extension. This name is not case-sensitive.
The account owner of the repository (e.g., username or organization name). This name is not case-sensitive.
The name of the branch. Wildcard characters are not supported in this field. To manage branch protections with wildcard patterns, please refer to the GitHub GraphQL API documentation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_COMMITRetrieves a specific commit from a repository by its owner, name, and a valid commit reference (SHA, branch, or tag), supporting pagination for large diffs.
Input parameters
The commit reference. Can be a commit SHA (e.g., '`sha`'), a branch name (e.g., 'heads/`BRANCH_NAME`' or simply '`BRANCH_NAME`'), or a tag name (e.g., 'tags/`TAG_NAME`'). For more information, see "\[Git References\](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
Page number for paginating the commit's diff if it's too large. For more information, see "\[Using pagination in the REST API\](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
Number of results per page when paginating the commit's diff (max 100). For more information, see "\[Using pagination in the REST API\](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_ADMIN_BRANCH_PROTECTIONChecks if repository administrators are subject to the branch protection rules on a specific branch.
Input parameters
Name of the repository, without the `.git` extension (case-insensitive).
Account owner of the repository (case-insensitive).
Name of the branch (wildcard characters not allowed; use GraphQL API for wildcard support).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_ALL_API_VERSIONSRetrieves all officially supported, date-based (e.g., "2022-11-28") versions of the GitHub REST API from the /versions endpoint.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_ALL_CONTRIBUTOR_COMMIT_ACTIVITYRetrieves commit activity (total commits, weekly additions/deletions/commits) for all contributors to a repository; may require a retry if GitHub returns 202 while preparing data.
Input parameters
Repository name, excluding `.git` (case-insensitive).
Username of the repository owner (case-insensitive).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_ALL_DEPLOYMENT_PROTECTION_RULES_FOR_ENVLists all enabled custom deployment protection rules for a specific environment in a repository; the environment must exist and be configured for deployments.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
The name of the environment. This name must be URL-encoded. For instance, if the environment name contains slashes (`/`), they should be replaced with `%2F`.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_MILESTONERetrieves detailed information for a specific milestone within a GitHub repository by its number.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username of the account that owns the repository. This field is not case-sensitive.
The unique sequential number identifying the milestone within the repository.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_AN_APPRetrieves publicly available information for an existing GitHub App, identified by its unique URL-friendly `app_slug`.
Input parameters
The app's unique, URL-friendly, lowercase, hyphenated identifier, derived from its name (e.g., 'my-awesome-app').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_AN_ARTIFACTGets a specific artifact for a repository by `artifact_id`. This action retrieves the details of a specific artifact from a GitHub repository using the artifact's unique identifier. It allows users to access information about artifacts stored in the repository.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
The unique identifier (ID) of the artifact to retrieve. This ID can be obtained from other API calls that list artifacts.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_AN_ASSIGNMENTRetrieves detailed information for a specific GitHub Classroom assignment if the authenticated user is an administrator of the classroom.
Input parameters
The unique identifier of the GitHub Classroom assignment to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_AN_AUTOLINK_REFERENCE_OF_A_REPOSITORYRetrieves a specific autolink reference (which automatically hyperlinks text like 'JIRA-123' to an external system) for a repository using its unique ID; requires administrator access to the repository.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
The unique numeric identifier of the autolink configuration to retrieve. You can get this ID from the 'Get all autolinks of a repository' action.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_AN_ENVIRONMENTRetrieves the details of a specific deployment environment for a given repository, including its name, configurations, and current status.
Input parameters
The name of the repository, without the `.git` extension. This name is not case-sensitive.
The username of the account that owns the repository. This name is not case-sensitive.
The name of the deployment environment. The name must be URL-encoded; for example, any slashes `/` must be replaced with `%2F`.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_AN_ENVIRONMENT_PUBLIC_KEYRetrieves the public key for a specified GitHub repository environment, used to encrypt secrets for GitHub Actions.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
The name of the environment. The name must be URL encoded. For example, any slashes (`/`) in the name must be replaced with `%2F`.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_AN_ENVIRONMENT_SECRETRetrieves metadata (name and timestamps) for a single secret in a GitHub Actions environment. Note: The actual secret value is never returned by this API for security reasons.
Input parameters
Name of the repository, without the `.git` extension (not case-sensitive).
Username or organization name of the repository owner (not case-sensitive).
Name of the secret to retrieve.
Name of the environment (must be URL-encoded if it contains special characters).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_AN_ENVIRONMENT_VARIABLERetrieves a specific environment variable from a GitHub Actions environment by repository owner, repository name, environment name, and variable name.
Input parameters
The name of the specific environment variable to retrieve.
The name of the repository, without the `.git` extension. This is not case-sensitive.
The username or organization name that owns the repository. This is not case-sensitive.
The name of the GitHub Actions environment. If the name contains special characters (e.g., slashes `/`), it must be URL-encoded (e.g., `staging/feature` becomes `staging%2Ffeature`).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_AN_ISSUERetrieves detailed information about a specific issue in a repository using the owner, repository name, and issue number.
Input parameters
Name of the repository (without `.git` extension). Not case-sensitive.
Username of the account owning the repository. Not case-sensitive.
The identifying number of the issue.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_AN_ISSUE_COMMENTAction to get an issue comment.
Input parameters
The name of the repository, without the `.git` extension. This field is not case sensitive.
The username of the account that owns the repository. This field is not case sensitive.
The unique identifier of the issue comment.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_AN_ISSUE_EVENTFetches details of a specific issue event for a given repository and event ID.
Input parameters
Name of the repository, without the `.git` extension. Not case-sensitive.
Username of the account owning the repository. Not case-sensitive.
Unique identifier for the issue event.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_AN_ORGANIZATIONGet an organization
Input parameters
The name of the organization. This name is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_AN_ORGANIZATION_PUBLIC_KEYAction for `GetAnOrganizationPublicKey`.
Input parameters
Organization name (case-insensitive).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_AN_ORGANIZATION_ROLERetrieves a specific GitHub organization role by its ID.
Input parameters
The name of the GitHub organization. This name is not case-sensitive.
The unique numerical identifier of the role within the organization.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_AN_ORGANIZATION_SECRETGets an organization secret's metadata (e.g., name, creation/update dates, visibility), but not its encrypted value.
Input parameters
Organization name (case-insensitive).
Name of the secret.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_AN_ORGANIZATION_VARIABLERetrieves details (name, value, visibility, timestamps) of a specific, existing variable for an existing GitHub organization.
Input parameters
Name of the organization (case-insensitive).
Name of the organization variable.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_AN_ORGANIZATION_WEBHOOKRetrieves the full configuration, including subscribed events and delivery settings, for an existing organization webhook.
Input parameters
The name of the GitHub organization. This field is not case-sensitive.
The unique identifier of the webhook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_PACKAGE_FOR_AN_ORGANIZATIONRetrieves a specific package (by type and name) from an organization, if both the package and organization exist.
Input parameters
Name of the GitHub organization (case-insensitive).
The unique name of the package.
Type of the package. GitHub Gradle packages use `maven` type. Images from `ghcr.io` (Container registry) use `container` type. Use `docker` for images from `docker.pkg.github.com` (Docker registry), even if migrated to the Container registry.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_PACKAGE_FOR_A_USERRetrieves metadata for a specific package owned by a GitHub user, using package type, name, and username as identifiers.
Input parameters
GitHub username of the package owner.
Unique name of the package on GitHub Packages.
Specifies the package's type. Note: Gradle packages use 'maven'; ghcr.io images use 'container'; 'docker' can find images migrated from docker.pkg.github.com to the Container registry.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_PACKAGE_FOR_THE_AUTHENTICATED_USERRetrieves detailed information for a specific package owned by the authenticated user.
Input parameters
The unique name of the package as it appears in the registry.
Type of the package. 'maven' for GitHub's Gradle registry; 'container' for Docker images in GitHub's Container registry (`ghcr.io`); 'docker' for images from GitHub's Docker registry (`docker.pkg.github.com`), including those migrated to the Container registry.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_PACKAGE_VERSION_FOR_AN_ORGANIZATIONRetrieves detailed information for a specific version of a package within an organization.
Input parameters
Organization name (case-insensitive).
Unique package name.
Package type. `maven` for GitHub Gradle registry. `container` for GitHub Container registry (`ghcr.io`) images. `docker` for images from GitHub Docker registry (`docker.pkg.github.com`), including migrated ones.
Unique ID of the package version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_PACKAGE_VERSION_FOR_A_USERRetrieves a specific public package version associated with a GitHub user.
Input parameters
The GitHub username of the account that owns the package.
The name of the package.
The type of package. 'maven' is used for Gradle packages. 'container' is for images in GitHub's Container registry (ghcr.io). 'docker' can be used for images previously in GitHub's Docker registry (docker.pkg.github.com).
The unique numeric identifier of the specific package version. Obtain this ID by first listing package versions using the 'list_package_versions_for_a_package_owned_by_a_user' action.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_PACKAGE_VERSION_FOR_THE_AUTHENTICATED_USERRetrieves detailed information for an existing specific package version associated with the authenticated user, identified by its type, name, and version ID.
Input parameters
The name of the package, which can be case-sensitive depending on the package type.
The package type. Note: GitHub's Gradle registry packages use 'maven'; ghcr.io images use 'container'; 'docker' can refer to images from docker.pkg.github.com.
The unique numerical identifier (ID) of the specific package version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_PROJECTRetrieves detailed information for a specific GitHub project (V2) using its project number and owner. Note: This action uses GitHub's Projects V2 REST API. The legacy Projects (classic) REST API was sunset on April 1, 2025. The project is identified by its number (visible in the project URL) and owner (either a username or organization name). If no owner is specified, the authenticated user is assumed.
Input parameters
The organization that owns the project. If provided, this takes precedence over username.
The GitHub username who owns the project. If not provided, defaults to the authenticated user.
The project's sequential number (e.g., 1, 2, 3). This is displayed in the project URL as https://github.com/users/{username}/projects/{project_number}.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_PROJECT_CARDRetrieves all details of a specific project card, given its unique `card_id`. DEPRECATION NOTICE: GitHub Projects (classic) REST API was sunset on April 1, 2025. This action only works with existing classic project cards that were created before the sunset date. For new projects, use GitHub Projects V2 (GraphQL API) instead.
Input parameters
The unique identifier of the project card.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_PROJECT_COLUMNRetrieves detailed information for a specific project column from GitHub Projects (classic). DEPRECATION NOTICE: GitHub Classic Projects (V1) and its REST API were sunset on April 1, 2025. This action will return 404 for most requests on GitHub.com. However, it may still work on GitHub Enterprise Server instances where classic projects are enabled. For new projects, use GitHub Projects V2 which uses the GraphQL API instead. See: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/ Returns column details including: id, name, url, project_url, cards_url, node_id, created_at, and updated_at timestamps.
Input parameters
The unique integer identifier of the project column to retrieve. This ID can be obtained from the 'list_project_columns' action or from the column's API URL (e.g., /projects/columns/12345).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_PULL_REQUESTRetrieves a specific pull request from a GitHub repository using its owner, repository name, and pull request number.
Input parameters
The name of the repository, without the .git extension. This value is not case sensitive.
The username of the account that owns the repository. This value is not case sensitive.
The number that identifies the specific pull request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_REFERENCERetrieves a specific Git reference (e.g., a branch, tag, or fully qualified like 'heads/main') from a GitHub repository. The reference must exist in the repository; use 'list_matching_references' first if unsure what references are available.
Input parameters
The Git reference to retrieve. Must be formatted as `heads/<branch_name>` for branches, `tags/<tag_name>` for tags, or `pull/<number>/head` (or `pull/<number>/merge`) for pull requests. Simple branch names (e.g., `main`) are automatically converted to `heads/<name>`. The reference must exist in the repository; a 404 error is returned if not found. If unsure which references exist, use 'list_matching_references' or 'get_a_branch' first. Note: Commit SHAs are not supported by this endpoint; use commit-specific endpoints instead. Not all repositories use 'master'; many now use 'main' as the default branch.
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_RELEASEGets a specific release from a GitHub repository, provided the repository is accessible and the release exists.
Input parameters
The name of the repository, without the '.git' extension. This field is not case-sensitive.
The username of the account that owns the repository. This field is not case-sensitive.
The unique numerical identifier for the release.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_RELEASE_ASSETGets metadata for a specific release asset in a GitHub repository, including a `browser_download_url` for downloading the asset.
Input parameters
The name of the repository, without the `.git` extension. This name is not case sensitive.
The account owner of the repository (GitHub username or organization name). This name is not case sensitive.
The unique numeric identifier of the release asset.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_RELEASE_BY_TAG_NAMEGets a release from a GitHub repository by its tag name; the repository and a release with this tag must already exist.
Input parameters
Tag identifying the release to fetch.
Name of the repository, without the `.git` extension (not case sensitive).
Account owner of the repository (not case sensitive).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_REPOSITORYRetrieves detailed information about an existing and accessible GitHub repository.
Input parameters
The name of the repository, without the `.git` extension. This field is case-insensitive.
The username of the account that owns the repository. This field is case-insensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_REPOSITORY_PUBLIC_KEYGets a repository's public key for encrypting secrets to be used in GitHub Actions, if the repository exists and is accessible.
Input parameters
Name of the repository without the `.git` extension (case-insensitive).
Account owner of the repository (case-insensitive).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_REPOSITORY_READMEFetches the README file (if it exists and is accessible) from a specified GitHub repository, returning its Base64-encoded content and metadata.
Input parameters
The specific git reference (branch name, tag name, or commit SHA) to retrieve the README from. If omitted, the repository's default branch is used.
The name of the repository, excluding the `.git` extension. This name is not case-sensitive.
The GitHub account owner of the repository. This name is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_REPOSITORY_README_FOR_A_DIRECTORYRetrieves the README file from a specified directory within a GitHub repository, optionally at a given commit, branch, or tag.
Input parameters
Path to the directory containing the README file.
Commit, branch, or tag name; defaults to the repository's default branch if not provided.
Name of the repository, without the `.git` extension (not case sensitive).
Username of the account owning the repository (not case sensitive).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_REPOSITORY_RULESETRetrieves a specific repository ruleset by its ID; if `includes_parents` is true, the search for this `ruleset_id` also extends to rulesets from parent organizations.
Input parameters
Repository name, excluding `.git` extension; case-insensitive.
Account owner of the repository (username or organization); case-insensitive.
Unique identifier of the ruleset.
If true, also returns rulesets configured at higher levels (e.g., organization) that apply to this repository.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_REPOSITORY_RULE_SUITEGets detailed information for a specific repository rule suite by its ID, including its evaluation status and the results of its individual rules.
Input parameters
The name of the repository, excluding the `.git` extension. This name is not case-sensitive.
The username of the account or the name of the organization that owns the repository. This name is not case-sensitive.
The unique identifier of the rule suite. To obtain this ID, you can list rule suites for the repository (e.g., via `GET /repos/{owner}/{repo}/rulesets/rule-suites`) or organization (e.g., via `GET /orgs/{org}/rulesets/rule-suites`).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_REPOSITORY_SECRETGets metadata (name, creation/update timestamps) for an existing repository secret, excluding its encrypted value.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
The name of the secret to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_REPOSITORY_SUBSCRIPTIONGets the authenticated user's subscription details for a repository, indicating if they receive notifications.
Input parameters
The name of the repository, without the `.git` extension. This is not case-sensitive.
The username of the account that owns the repository. This is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_REPOSITORY_VARIABLEGets a specific GitHub Actions variable by name from an accessible repository.
Input parameters
The name of the GitHub Actions variable to retrieve.
The name of the repository, without the `.git` extension.
The username or organization that owns the repository.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_REPOSITORY_WEBHOOKReturns the configuration of an existing webhook for a given repository.
Input parameters
The name of the repository without the `.git` extension. The name is not case-sensitive.
The account owner of the repository (e.g., a user or organization). The name is not case-sensitive.
The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_REVIEW_COMMENT_FOR_A_PULL_REQUESTRetrieves a specific pull request review comment by its ID, provided the repository exists, is accessible, and the comment ID is valid.
Input parameters
The name of the repository (without the `.git` extension). Not case-sensitive.
The account owner of the repository (GitHub username or organization name). Not case-sensitive.
Unique identifier of the pull request review comment.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_REVIEW_FOR_A_PULL_REQUESTRetrieves a specific review for a pull request using its owner, repository, pull request number, and review ID.
Input parameters
The name of the repository, without the `.git` extension. This is not case sensitive.
The username of the account that owns the repository. This is not case sensitive.
The unique numeric identifier of the review.
The numeric identifier of the pull request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_SECRET_FOR_THE_AUTHENTICATED_USERRetrieves metadata (name, timestamps, visibility; not the value) for a specific, existing development environment secret associated with the authenticated user's GitHub Codespaces.
Input parameters
The name of the secret to retrieve. This is case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_SELF_HOSTED_RUNNER_FOR_AN_ORGANIZATIONRetrieves detailed information about a specific self-hosted runner registered within a GitHub organization.
Input parameters
The login name of the GitHub organization. This name is not case-sensitive.
Unique identifier (ID) of the self-hosted runner.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_SELF_HOSTED_RUNNER_FOR_A_REPOSITORYGets a specific self-hosted runner for a repository by its unique ID.
Input parameters
The name of the repository, without the `.git` extension. This is not case-sensitive.
The username of the account that owns the repository. This is not case-sensitive.
The unique identifier (ID) of the self-hosted runner.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_ASSIGNMENT_GRADESRetrieves all grades for an existing GitHub Classroom assignment.
Input parameters
The unique identifier of the classroom assignment. This can be obtained from the list_assignments_for_a_classroom action or from the assignment's URL in GitHub Classroom.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_TAGRetrieves detailed information for a specific Git tag object from a GitHub repository, using the SHA of the tag object itself.
Input parameters
Name of the repository, without the `.git` extension (case-insensitive).
Username or organization that owns the repository (case-insensitive).
SHA of the Git tag object to retrieve; this is the SHA of the tag object, not the commit it may point to.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_TEAM_BY_NAMERetrieves a GitHub team by its slug from a specific organization.
Input parameters
The organization's name (case-insensitive).
The slug (URL-friendly version) of the team name.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_THREADRetrieves a specific GitHub notification thread using its unique `thread_id`.
Input parameters
The unique identifier of the notification thread, typically obtained from a list of notifications.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_THREAD_SUBSCRIPTION_FOR_THE_AUTHENTICATED_USERRetrieves the authenticated user's subscription details for a specific notification thread, identified by `thread_id`.
Input parameters
The unique identifier of the notification thread. This ID corresponds to the `id` field returned when retrieving notifications, for example, through the 'List notifications for the authenticated user' (GET /notifications) operation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_TREEBrowse and list all files/directories in a GitHub repository. Efficiently retrieves the complete repository structure in a single API call when used with recursive mode. Perfect for analyzing codebase structure, finding specific files, or getting an overview of repository contents without cloning.
Input parameters
Repository name without owner or .git extension (e.g., for github.com/kubernetes/kubernetes, repo is 'kubernetes').
Repository owner username or organization name (e.g., for github.com/kubernetes/kubernetes, owner is 'kubernetes').
Branch name (e.g., 'main', 'master'), tag name (e.g., 'v1.0.0'), commit SHA, or tree SHA. Directory paths are NOT supported - use a branch/tag to get the full tree, then extract the directory's SHA from results.
Set to True (or '1'/'true') to fetch the ENTIRE repository file tree recursively (all files and directories in one call). Set to False or leave empty to fetch only the top-level files/folders. For browsing or analyzing the full repository structure, use recursive=True.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_USERRetrieves the public profile information for an existing GitHub user, specified by their username.
Input parameters
The GitHub username (handle) of the user to retrieve. This is case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_WEBHOOK_CONFIGURATION_FOR_AN_ORGANIZATIONRetrieves the configuration for a specific webhook associated with a GitHub organization.
Input parameters
The GitHub organization's name (case-insensitive).
Unique ID of the webhook (see `X-GitHub-Hook-ID` header in webhook deliveries).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_WEBHOOK_CONFIGURATION_FOR_A_REPOSITORYReturns the configuration for an existing webhook on the specified repository.
Input parameters
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_WEBHOOK_DELIVERY_FOR_AN_ORGANIZATION_WEBHOOKReturns detailed information for a specific delivery attempt of a webhook configured for the specified GitHub organization.
Input parameters
The name of the GitHub organization. This field is not case-sensitive.
The unique identifier of the organization webhook. This ID can be found in the `X-GitHub-Hook-ID` header of a webhook delivery.
The unique identifier of the specific webhook delivery attempt.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_WORKFLOWRetrieves detailed information for a specific GitHub Actions workflow in a repository, identified by either its numeric ID or its filename.
Input parameters
Name of the repository, without the `.git` extension (case-insensitive).
Username or organization name owning the repository (case-insensitive).
Unique numeric identifier of the workflow; use this or `workflow_name`.
Full name of the workflow file (e.g., `ci.yml`); use this or `workflow_id`.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_WORKFLOW_RUNGets a specific workflow run by its ID from a GitHub repository.
Input parameters
Name of the repository (case-insensitive, without .git extension).
The username or organization name that owns the repository (not case-sensitive).
Unique ID of the workflow run.
If true, excludes pull request data; the `pull_requests` array in the response will be empty.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_A_WORKFLOW_RUN_ATTEMPTRetrieves detailed information for a specific attempt of a workflow run in a GitHub repository, including its status, conclusion, and timings.
Input parameters
The name of the repository, without the `.git` extension. This name is not case sensitive.
The account owner of the repository, such as a GitHub username or organization name. This name is not case sensitive.
The unique identifier (ID) of the workflow run. This ID is specific to a repository and can be obtained from API calls that list workflow runs.
The attempt number of the specific workflow run. Each re-run of a workflow creates a new attempt number, starting from 1.
If `true`, excludes pull request data from the API response; the `pull_requests` array in the response will then be empty.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_BILLING_USAGE_REPORT_USERRetrieves the billing usage report for a specified GitHub user. Use when you need to analyze billing costs and usage patterns.
Input parameters
If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.
If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.
If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used.
The handle for the GitHub user account.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_BRANCH_PROTECTIONRetrieves branch protection settings for a specific, existing, and accessible branch in a GitHub repository; protection feature availability varies by GitHub product plan.
Input parameters
Name of the repository, without the `.git` extension; not case-sensitive.
Account owner of the repository (username or organization name); not case-sensitive.
Name of the branch; wildcard characters are not supported (use GitHub GraphQL API for wildcard matching).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_CATALOG_MODELSTool to retrieve the list of AI models available in the GitHub Models catalog. Use when you need to discover available models, their capabilities, token limits, and supported modalities.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_CHECK_RUNRetrieves detailed information for a specific check run within a GitHub repository.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username of the account that owns the repository. This field is not case-sensitive.
The unique numerical identifier of the check run.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_CHECK_SUITERetrieves a specific check suite (a collection of check runs) by its ID from a repository accessible to the authenticated user.
Input parameters
The name of the repository, without the `.git` extension. This value is not case sensitive.
The username of the account that owns the repository. This value is not case sensitive.
The unique identifier of the check suite.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_CLASSROOMRetrieves details for a specific GitHub Classroom. Requires the authenticated user to be an administrator of the classroom.
Input parameters
The unique identifier of the classroom.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_CODE_OF_CONDUCTRetrieves the full details of a specific GitHub code of conduct using its unique key.
Input parameters
Unique key for a specific code of conduct.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_CODE_OF_CONDUCT_GRAPH_QLTool to look up a code of conduct by its key using GitHub's GraphQL API. Use when you need to fetch code of conduct details as part of a GraphQL workflow.
Input parameters
The unique key identifier for the code of conduct to retrieve. Common keys include 'contributor_covenant', 'citizen_code_of_conduct', and 'django'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_CODEQL_DATABASEGets an existing CodeQL database (including a download URL) for a specified language in an accessible repository, if one has been successfully built for that language.
Input parameters
The name of the repository, without the `.git` extension. This name is not case-sensitive.
The account owner of the repository. This name is not case-sensitive.
The programming language of the CodeQL database to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_CODE_SCANNING_ALERTRetrieves a specific code scanning alert, which identifies potential code vulnerabilities or errors, by its number from the specified GitHub repository.
Input parameters
Repository name, without the `.git` extension (case-insensitive).
Username of the account owning the repository (case-insensitive).
Unique number identifying the code scanning alert (must be >= 1), found in the alert's URL or API responses.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_CODE_SCANNING_ANALYSISRetrieves detailed information for a specific code scanning analysis on an accessible repository, identified by its `analysis_id`.
Input parameters
Name of the repository, without the `.git` extension (not case-sensitive).
Username or organization name owning the repository (not case-sensitive).
Unique ID of the code scanning analysis, obtained by listing all analyses for the repository.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_CODE_SCANNING_DEFAULT_SETUPGets the default setup configuration for code scanning in a repository, including state, languages, query suite, and schedule for a repository if it exists.
Input parameters
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_CODESPACECall to retrieve detailed information for a `codespace_name` belonging to the authenticated user, ensuring the codespace exists and is accessible.
Input parameters
Unique name or identifier of the codespace, typically auto-generated upon creation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_COMMIT_AUTHORSFetches commit authors identified during a repository import, used to map authors from an external VCS to GitHub accounts. NOTE: This endpoint has been deprecated by GitHub as of April 12, 2024, and is no longer available. The Source Imports REST API has been retired due to very low usage levels. Please use the GitHub Importer tool at https://github.com/new/import for repository imports.
Input parameters
The name of the repository, without the `.git` extension. This name is not case-sensitive.
The username of the account that owns the repository. This name is not case-sensitive.
An optional author ID. If provided, only authors with an ID greater than this specified ID will be returned. This ID refers to the `id` field of an author object in the response, and can be used for paginating through the list of authors.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_COMMIT_COMMENTRetrieves the full details of a specific commit comment in a GitHub repository, using its unique identifier.
Input parameters
The name of the repository, without the `.git` extension. This name is not case-sensitive.
The account owner of the repository. This name is not case-sensitive.
The unique identifier of the commit comment.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_COMMIT_OBJECTRetrieves detailed information (including author, committer, message, tree, parents, verification) for a specific commit in a GitHub repository, identified by its SHA.
Input parameters
Name of the repository without the `.git` extension. The name is not case sensitive.
Account owner of the repository. The name is not case sensitive.
SHA identifier of the commit.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_COMMIT_SIGNATURE_PROTECTIONGets the commit signature protection status for a branch in a repository.
Input parameters
The name of the repository, without the `.git` extension. This name is not case sensitive.
The account owner of the repository. This name is not case sensitive.
The name of the branch. This name IS case-sensitive (unlike owner and repo). Wildcard characters are not allowed. To use wildcard characters in branch names, consider using the GraphQL API.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_COMMIT_STATUSESList all statuses for a commit reference (SHA, branch, or tag) in reverse chronological order. Use when you need to check CI/CD status results from various systems for a specific commit.
Input parameters
The commit reference. Can be a commit SHA, branch name (heads/BRANCH_NAME), or tag name (tags/TAG_NAME).
Page number of results to fetch. Default: 1
The name of the repository without the .git extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
Number of results per page, maximum 100. Default: 30
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_COMMUNITY_PROFILE_METRICSRetrieves a repository's community profile metrics, including health percentage and the presence of key community files (e.g., README, LICENSE).
Input parameters
Name of the repository, without '.git' extension. Not case-sensitive.
Username of the account owning the repository. Not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_CONTEXTUAL_INFORMATION_FOR_A_USERGets contextual hovercard information for a GitHub user; `subject_type` and `subject_id` can be jointly provided for more specific details.
Input parameters
GitHub username for whom to retrieve hovercard data.
Entity ID for `subject_type` for more specific hovercard context; required if `subject_type` is also given.
Entity type for more specific hovercard context (e.g., 'repository'); required if `subject_id` is also given.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_CUSTOM_DEPLOYMENT_PROTECTION_RULERetrieves a specific custom deployment protection rule (used by GitHub Apps for external validation or manual approval of deployments) for a given environment in a repository.
Input parameters
The name of the repository without the `.git` extension. This name is not case sensitive.
The account owner of the repository (username or organization name). This name is not case sensitive.
The name of the environment. The name must be URL encoded if it contains special characters (e.g., any slashes `/` must be replaced with `%2F`).
The unique identifier of the custom deployment protection rule. Get this ID from GITHUB_GET_ALL_DEPLOYMENT_PROTECTION_RULES_FOR_AN_ENVIRONMENT action.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_DEFAULT_ATTRIBUTES_FOR_A_CODESPACEGet pre-flight data (e.g., default location, devcontainer path) for creating a Codespace in a given repository (must exist and be accessible), optionally for a specific Git ref.
Input parameters
Git reference (branch name, tag name, or commit SHA) for devcontainer configuration. If omitted, the repository's default branch is used.
Name of the repository, without the `.git` extension (case-insensitive).
Username of the account owning the repository (case-insensitive).
Optional IP address to override default location auto-detection (e.g., for proxied requests). If unspecified, location is inferred from source IP.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_DEFAULT_WORKFLOW_PERMISSIONS_FOR_AN_ORGANIZATIONGets the default GITHUB_TOKEN workflow permissions and settings for a GitHub organization.
Input parameters
The name of the organization. This name is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_DEFAULT_WORKFLOW_PERMISSIONS_FOR_A_REPOSITORYGets the default workflow permissions (`read` or `write`) for the GITHUB_TOKEN and whether it can approve pull request reviews in an existing and accessible repository.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_DEPENDENCY_DIFFGets the dependency diff between two Git revisions in a repository, where 'basehead' specifies the revisions and 'name' can optionally scope to a specific manifest file.
Input parameters
The optional full path, relative to the repository root, of a specific dependency manifest file (e.g., `package-lock.json`, `pom.xml`). If provided, the diff will be scoped to this file.
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
A string specifying the base and head Git revisions to compare, in the format `BASE_REF...HEAD_REF`. `BASE_REF` and `HEAD_REF` can be commit SHAs, branch names, or tags. For example, `main...develop` or `v1.0.0...v1.1.0`.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_DEPLOY_KEYGets a specific deploy key, identified by its `key_id`, for the GitHub repository specified by `owner` and `repo`.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
The unique numerical identifier of the deploy key.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_DEPLOYMENTGets a specific deployment by ID from a repository, provided the repository and deployment ID exist.
Input parameters
The name of the repository, without the '.git' extension. This field is not case-sensitive.
The username of the account that owns the repository. This field is not case-sensitive.
The unique numeric identifier of the deployment to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_DEPLOYMENT_BRANCH_POLICYRetrieves a specific deployment branch policy for an environment in a repository, identified by its unique ID.
Input parameters
The name of the repository, without the `.git` extension. This name is not case-sensitive.
The account owner of the repository. This name is not case-sensitive.
The unique identifier of the branch policy.
The name of the environment. The name must be URL encoded; for example, replace any slashes in the name with `%2F`.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_DEPLOYMENT_STATUSRetrieves a specific deployment status by its ID for a given deployment within a GitHub repository.
Input parameters
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
The unique identifier of the deployment status.
The unique identifier of the deployment.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_DETAILS_ABOUT_A_CODESPACE_EXPORTRetrieves detailed information about a specific export of a codespace.
Input parameters
The ID of the export operation. Currently, only 'latest' is supported, which refers to the most recent export for the specified codespace.
The unique name of the codespace.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_DISCUSSIONFetches a specific discussion by its number from a team within an organization. This is a read-only action that retrieves discussion details including title, body, author information, comment count, and reactions. The authenticated user must be a member of the organization to access team discussions.
Input parameters
The organization's name (case-insensitive).
The team's slug (URL-friendly name).
The discussion's unique number within the team.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_DISCUSSION_COMMENTFetches a specific comment from a team discussion within a specific organization.
Input parameters
The name of the organization. This field is not case-sensitive.
The slug of the team name. This is the team name converted to lowercase, with spaces and special characters replaced by hyphens. For example, 'Developer Tools Team' becomes 'developer-tools-team'.
The unique number identifying the comment within the discussion.
The unique number identifying the discussion.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_EMOJISLists all emojis available for use on GitHub, including custom and Unicode emojis.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_ENTERPRISE_MEMBER_INVITATIONTool to look up a pending enterprise unaffiliated member invitation by invitee and enterprise. Use when you need to check the status of a specific invitation.
Input parameters
The login (username) of the user invited to join the enterprise. This is the GitHub username of the invitee.
The slug of the enterprise the user was invited to join. Enterprise slugs are used to identify enterprises in GitHub URLs (e.g., 'acme-corp').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_FEEDSFetches a list of available GitHub feed URLs for the authenticated user.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_GISTFetches a specific GitHub gist by its `gist_id`, returning comprehensive details if the gist exists.
Input parameters
The unique hexadecimal string identifier of the gist, found in its URL.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_GIST_COMMENTRetrieves a specific Gist comment by its ID and the Gist's ID.
Input parameters
The unique alphanumeric identifier of the Gist (found in the Gist URL after gist.github.com/username/).
The unique numeric identifier of the comment. Obtain this from listing gist comments or from the comment URL.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_GIST_REVISIONRetrieves a specific revision of a gist.
Input parameters
The SHA (Secure Hash Algorithm) identifier of a specific gist revision. This is a 40-character hexadecimal string.
The unique identifier of the gist.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_GITHUB_ACTIONS_CACHE_USAGE_FOR_AN_ORGANIZATIONRetrieves total GitHub Actions cache usage statistics for an organization, including active cache count and size across all repositories.
Input parameters
Name of the organization (case-insensitive).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_GITHUB_ACTIONS_CACHE_USAGE_FOR_A_REPOSITORYRetrieves the total count of active GitHub Actions caches and their combined size in bytes for a specified repository.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_GITHUB_ACTIONS_PERMISSIONS_FOR_AN_ORGANIZATIONGets the GitHub Actions permissions for a specified organization, detailing repository enablement and allowed actions policies.
Input parameters
The name of the GitHub organization. This field is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_GITHUB_ACTIONS_PERMISSIONS_FOR_A_REPOSITORYGets the GitHub Actions permissions policy for a repository, including its enabled status and the scope of allowed actions.
Input parameters
The name of the repository, without the `.git` extension. This is not case-sensitive.
The username of the account that owns the repository. This is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_GITHUB_BILLING_PREMIUM_REQUEST_USAGE_REPORT_USERTool to get billing premium request usage report for a GitHub user. Use when you need to retrieve usage data for premium features like Copilot or AI models.
Input parameters
If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.
If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.
The model name to query usage for. The name is not case sensitive.
If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used.
The product name to query usage for. The name is not case sensitive.
The handle for the GitHub user account.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_GITHUB_BILLING_USAGE_SUMMARY_FOR_USERTool to retrieve billing usage summary for a GitHub user account. Use when tracking usage costs, monitoring billing details, or generating usage reports for a specific user. Note: This endpoint only returns data for the past 24 months and is currently in public preview.
Input parameters
If specified, only return results for a single day. The value of day is an integer between 1 and 31. If no year or month is specified, the default year and month are used.
The SKU to query for usage.
If specified, only return results for a single year. The value of year is an integer with four digits representing a year (e.g., 2025). Default value is the current year.
If specified, only return results for a single month. The value of month is an integer between 1 and 12. Default value is the current month. If no year is specified the default year is used.
The product name to query usage for. The name is not case sensitive.
The handle for the GitHub user account.
The repository name to query for usage in the format owner/repository.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_GITHUB_META_INFORMATIONFetches GitHub's publicly available metadata, useful for configuring network security policies or IP allow-listing.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_GITHUB_PAGES_BUILDRetrieves detailed information about a specific GitHub Pages build for a repository, which must have GitHub Pages enabled.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
The unique identifier of the GitHub Pages build to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_GITIGNORE_TEMPLATERetrieves a specific .gitignore template from GitHub by its name, which must be an existing template in GitHub's collection.
Input parameters
The name of the .gitignore template to retrieve (e.g., 'Python', 'Node'). This is case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_GLOBAL_SECURITY_ADVISORYRetrieve a global GitHub security advisory by its GHSA identifier. Use this to get detailed information about vulnerabilities including severity, affected packages, CVSS scores, and references.
Input parameters
The GHSA (GitHub Security Advisory) identifier of the advisory.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_GRAPHQL_NODETool to fetch any GitHub object by its global node ID. Use when you have a node_id and need to retrieve the corresponding object details.
Input parameters
The global node ID of the object to fetch. This is the GraphQL global identifier (node_id) returned by GitHub's API, not the numeric ID.
Optional GraphQL fragment to specify which fields to retrieve from the returned node. Use GraphQL inline fragment syntax (e.g., '... on User { login name }'). If omitted, only the 'id' field will be returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_GRAPHQL_RATE_LIMITTool to retrieve the authenticated client's GitHub GraphQL API rate limit information. Use when you need to check remaining quota, current usage, or reset time for GraphQL requests.
Input parameters
If true, calculate the cost for the query without evaluating it. Use this to estimate query costs without consuming actual quota.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_INFORMATION_ABOUT_A_SARIF_UPLOADRetrieves detailed information, including processing status and results URL, about a specific SARIF (Static Analysis Results Interchange Format) upload for a repository, uniquely identified by its sarif_id.
Input parameters
Name of the repository, without the `.git` extension (not case-sensitive).
Username of the account that owns the repository (not case-sensitive).
Unique identifier of the SARIF upload, returned when a SARIF file is successfully uploaded.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_INTERACTION_RESTRICTIONS_FOR_AN_ORGANIZATIONRetrieves interaction restrictions for an organization, showing which GitHub user types can interact with its public repositories and when restrictions expire; returns an empty response if no restrictions are set.
Input parameters
The name of the organization. This name is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_INTERACTION_RESTRICTIONS_FOR_A_REPOSITORYRetrieves active interaction restrictions for a repository, detailing which user groups are limited from activities like commenting or creating pull requests, and when these restrictions expire.
Input parameters
The name of the repository, without the `.git` extension. This is case-insensitive.
The username of the account that owns the repository. This is case-insensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_INTERACTION_RESTRICTIONS_FOR_PUBLIC_REPOSRetrieves currently active interaction restrictions for the authenticated user's public repositories.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_LABELRetrieves a specific label by its name from a specified GitHub repository.
Input parameters
The name of the label to retrieve. GitHub's API treats label names as case-insensitive for this operation.
The name of the repository, without the `.git` extension. The name is not case-sensitive.
The account owner of the repository (e.g., a username or organization name). The name is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_LARGE_FILESLists files larger than 100MB identified during a previous source import for the specified repository. NOTE: This endpoint has been deprecated by GitHub as of April 12, 2024, and is no longer available. The Source Imports REST API has been retired due to very low usage levels. Please use the GitHub Importer tool at https://github.com/new/import for repository imports.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_LATEST_PAGES_BUILDRetrieves information about the most recent GitHub Pages build for a repository, which must exist, be accessible, have GitHub Pages enabled, and have at least one prior build.
Input parameters
The name of the repository, without the '.git' extension. This name is not case-sensitive.
The username of the account or the name of the organization that owns the repository. This name is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_LICENSECall this action to retrieve comprehensive details for a specific software license recognized by GitHub, using its unique license key.
Input parameters
The unique identifier (key) of the license. This is typically the SPDX license identifier (e.g., 'mit', 'apache-2.0').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_LICENSE_GRAPH_QLTool to look up an open source license by its SPDX ID using GitHub's GraphQL API. Use when you need to fetch license details for compliance tracking or repository setup.
Input parameters
The license's downcased SPDX ID. Common keys include 'mit', 'apache-2.0', 'gpl-3.0', 'bsd-3-clause', 'lgpl-3.0', 'mpl-2.0', 'agpl-3.0', 'unlicense', 'isc', 'bsd-2-clause'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_OCTOCATFetches an ASCII art representation of GitHub's Octocat, suitable for text-based displays.
Input parameters
Custom message for Octocat's speech bubble. If omitted or empty, a random 'Zen of GitHub' message will be displayed instead.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_OIDC_SUBJECT_CLAIM_TEMPLATERetrieves the OpenID Connect (OIDC) subject claim customization template for a repository, which defines the `sub` claim structure in OIDC tokens for GitHub Actions workflows; returns the default configuration if no customization is applied.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_ORG_ALLOWED_ACTIONSGets the list of allowed actions and reusable workflows for an organization when the 'allowed_actions' policy is set to 'selected'.
Input parameters
The unique identifier or name of the organization. This field is not case sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_ORGANIZATION_AUDIT_LOGTool to retrieve an organization's audit log events for security and compliance investigations. Use when tracking organizational changes, security audits, or compliance monitoring. Requires organization owner permissions and read:audit_log scope.
Input parameters
The organization name. The name is not case sensitive.
A cursor for pagination. Returns events after this cursor. Use the cursor from the response to fetch the next page.
The order of audit log events. Can be 'asc' (ascending, oldest first) or 'desc' (descending, newest first). Defaults to 'desc'.
A cursor for pagination. Returns events before this cursor. Use the cursor from the response to fetch the previous page.
A search phrase to filter audit log events. For example, 'action:org' for organization-related events, or 'actor:octocat' for events by a specific user.
The event types to include. Can be 'web' (web interface events), 'git' (Git events), or 'all'. Defaults to 'web'.
The number of results per page (max 100). Defaults to 30.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_ORGANIZATION_CUSTOM_PROPERTYRetrieves the definition (schema) of a specific, existing custom property for an organization.
Input parameters
Organization's login name (not case-sensitive).
Name of the custom property to retrieve (case-sensitive).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_ORGANIZATION_PROJECT_ITEMTool to get an item from an organization-owned GitHub Projects V2 project. Use when you need to retrieve details about a specific project item including its content, fields, timestamps, and creator information.
Input parameters
The organization name. The name is not case sensitive.
Limit results to specific fields, by their IDs. If not specified, the title field will be returned. Format: fields\[\]=123&fields\[\]=456 or fields=123,456,789
The unique identifier of the project item.
The project's number.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_ORGANIZATION_PUBLIC_KEYRetrieves an organization's public key, which must be used to encrypt secret values before they are configured for Codespaces.
Input parameters
The name of the GitHub organization. This field is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_ORGANIZATION_PUBLIC_KEY_FOR_DEPENDABOTRetrieves the public key for an existing GitHub organization, required for encrypting Dependabot secrets. Requires admin:org scope.
Input parameters
The name of the GitHub organization. Requires admin:org scope (must be an organization admin). This field is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_ORG_DEV_ENVIRONMENT_SECRET_SAFELYRetrieves metadata for a specific secret available to an organization's GitHub Codespaces without exposing its encrypted value.
Input parameters
The organization name (login). The name is not case-sensitive.
The name of the development environment secret to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_ORG_OIDC_SUBJECT_CLAIM_TEMPLATERetrieves the OpenID Connect (OIDC) subject claim customization template for a GitHub organization, which defines how the `sub` claim in OIDC tokens for workflows is constructed.
Input parameters
The name of the GitHub organization (case-insensitive). This is the organization's login/username, not a numeric ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_PAGES_DNS_HEALTH_CHECKRetrieves the DNS health check status (e.g., CNAME/A records, HTTPS) for a GitHub Pages site; the check may be pending (HTTP 202) on initial calls or after site changes.
Input parameters
The name of the repository, without the `.git` extension. This field is not case sensitive.
The username or organization name that owns the repository. This field is not case sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_PAGES_SITERetrieves information for a GitHub Pages site, which must be enabled for the repository.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_PAGE_VIEWSRetrieves page view statistics for a repository over the last 14 days, including total views, unique visitors, and a daily or weekly breakdown.
Input parameters
The time unit for which to aggregate page views.
The name of the repository, without the `.git` extension. This field is case-insensitive.
The username of the account that owns the repository. This field is case-insensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_PENDING_DEPLOYMENTS_FOR_A_WORKFLOW_RUNRetrieves pending deployment environments for a specific workflow run that are awaiting approval due to protection rules.
Input parameters
Name of the repository, without the `.git` extension; not case-sensitive.
Account owner of the repository (user or organization); not case-sensitive.
Unique numerical identifier of the workflow run.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_PROJECT_PERMISSION_FOR_A_USERRetrieves permission information for a GitHub project (classic) collaborator. Returns the permission level and full user object for a collaborator on a GitHub project (classic). The permission returned can be admin, write, read, or none.
Input parameters
The GitHub username of the project owner or the user whose permission is being checked.
The unique identifier (number) of the project.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_PUBLIC_KEY_FOR_SECRET_ENCRYPTIONRetrieves a repository's public key for encrypting GitHub Codespaces secrets; requires `repo` scope or equivalent read access to codespaces secrets for private repositories.
Input parameters
Repository name, without the `.git` extension (not case-sensitive).
Username or organization name of the repository owner (not case-sensitive).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_PUBLIC_KEY_FOR_THE_AUTHENTICATED_USERRetrieves the authenticated user's public key for encrypting GitHub Codespaces secrets. The returned key must be used with libsodium sealed box encryption before creating or updating secrets via the API.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_PULL_REQUEST_REVIEW_PROTECTIONRetrieves the pull request review protection settings for a specific branch in a GitHub repository, if such protection is configured.
Input parameters
The name of the repository, without the `.git` extension. This name is not case-sensitive. For example, in 'octocat/Hello-World', 'Hello-World' is the repository name.
The account owner of the repository. This name is not case-sensitive. For example, in 'octocat/Hello-World', 'octocat' is the owner.
The name of the branch. Wildcard characters are not allowed. To use wildcard characters in branch names, refer to the GitHub GraphQL API.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_RATE_LIMIT_STATUS_FOR_THE_AUTHENTICATED_USERRetrieves the authenticated user's current GitHub API rate limit status, including usage and limits across different resource categories.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_RAW_REPOSITORY_CONTENTTool to fetch raw file content from a GitHub repository. Returns raw bytes in whatever format the file uses (JSON, CSV, binary, etc.) — parsing and validation are the caller's responsibility. Ensure owner, repo, ref, and path are consistent when combining with other GitHub tools to avoid mismatched-ref errors.
Input parameters
The branch name, tag name, or commit SHA to fetch the file from. Defaults to the repository's default branch (usually 'main' or 'master'). Recommended to pass explicitly — omitting it fetches from the default branch, which may not match the ref used in other tool calls and can yield unexpected or missing content.
The file path within the repository, relative to the repository root. Use forward slashes for directory separators (e.g., 'src/utils/helper.js'). Do not include leading slash. Do NOT pass a full GitHub URL - only the relative path within the repo. Must exactly match the file path as it exists in the repository — use GITHUB_GET_A_TREE to discover valid paths rather than guessing directory structure.
The repository name (not the full URL). This is the repository name shown in the repository URL (e.g., for github.com/torvalds/linux, the repo is 'linux'). Do not include '.git' suffix. Case-insensitive.
The GitHub username or organization name that owns the repository. This is the account name shown in the repository URL (e.g., for github.com/torvalds/linux, the owner is 'torvalds'). Case-insensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_REPO_ALLOWED_ACTIONSGets the settings for allowed actions and reusable workflows in a repository. Requires the repository's `allowed_actions` policy to be set to `selected` (returns 409 if set to `all` or `local_only`).
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_REPO_DEV_ENV_SECRETGets metadata (name, creation/update timestamps) for a specific, existing development environment secret (Codespaces secret) in a repository, without exposing its value.
Input parameters
The name of the repository, without the `.git` extension. This field is case-insensitive.
The username or organization name that owns the repository. This field is case-insensitive.
The name of the development environment secret to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_REPOS_ATTESTATIONSTool to retrieve attestations by subject digest from a GitHub repository. Use when you need to verify or check attestations for a specific artifact identified by its SHA256 digest.
Input parameters
The name of the repository without the `.git` extension. The name is not case sensitive.
A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API".
The account owner of the repository. The name is not case sensitive.
A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API".
The number of results per page (max 100). For more information, see "Using pagination in the REST API".
Optional filter for fetching attestations with a given predicate type. This option accepts `provenance`, `sbom`, `release`, or freeform text for custom predicate types.
The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_REPOSITORY_CLONESRetrieves the total number of clones and a breakdown of clone activity (daily or weekly) for a specified repository over the preceding 14 days.
Input parameters
Specifies the time frame for aggregating clone data: `day` for daily clone counts, or `week` for weekly clone counts (a week starts on Monday).
The name of the repository, without the '.git' extension. This field is not case-sensitive.
The username of the account that owns the repository. This field is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_REPOSITORY_CONTENTRetrieves a file's Base64 encoded content or lists a directory's contents from a GitHub repository.
Input parameters
The name of the commit, branch, or tag to read from. Use this parameter to specify which branch (e.g., 'feat/godlocal-dev', 'main', 'develop'), tag (e.g., 'v1.2.0'), or commit SHA you want to access. If not provided, the repository's default branch will be used. Note: Branch names should be passed here, NOT in the path parameter.
Required. Path to file or directory in the repository. Empty string ('') retrieves root directory contents. Leading slashes auto-stripped. CRITICAL: Do NOT pass branch names here (e.g., 'feat/godlocal-dev', 'main'). Branch names belong in the `ref` parameter. Path should be file/directory path only (e.g., 'src/main.js', 'README.md'), NOT prefixed with branch name (use 'src/main.js' not 'main/src/main.js'). File paths must include extension (e.g., 'README.md', not 'README'). For common files (README, LICENSE, CHANGELOG) without extensions, action auto-tries common extensions (.md, .txt, .rst). Paths are case-sensitive. On 404 errors, list parent directory to verify exact path/casing.
Required. The name of the repository, without the `.git` extension. This name is not case sensitive.
Required. The account owner of the repository. This name is not case sensitive. Can also accept full repository path in format 'owner/repo' - the repo part will be extracted automatically.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_REPOSITORY_GRAPH_QLTool to lookup a repository by owner and name using GitHub's GraphQL API. Use when you need comprehensive repository information.
Input parameters
The name of the repository.
The login field of a user or organization that owns the repository.
Follow repository renames. If true, the query will follow repository renames to find the current repository.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_REPOSITORY_OWNERTool to lookup a repository owner (User or Organization) by login using GitHub's GraphQL API. Use when you need to determine whether a login is a user or organization and retrieve basic profile information.
Input parameters
The username or organization name to lookup. This is case-sensitive and must match the exact GitHub login.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_REPOSITORY_PERMISSIONS_FOR_A_USERRetrieves a specific user's permission level ('admin', 'write', 'read', or 'none') for a given repository, where 'maintain' role is reported as 'write' and 'triage' as 'read'.
Input parameters
Name of the repository, without the `.git` extension (case-insensitive).
Account owner of the repository (case-insensitive).
GitHub user's handle (case-insensitive).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_REPOSITORY_PUBLIC_KEY_FOR_ENCRYPTIONGets a repository's public key, used to encrypt secrets for Dependabot.
Input parameters
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_REPOSITORY_SECRET_SECURELYRetrieves metadata for an existing Dependabot secret in a repository, without exposing its encrypted value.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
The name of the Dependabot secret to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_REPOSITORY_SECURITY_ADVISORYTool to retrieve a repository security advisory using its GHSA identifier. Use when you need detailed information about a specific security vulnerability.
Input parameters
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
The GHSA (GitHub Security Advisory) identifier of the advisory.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_REPOSITORY_WEBHOOK_DELIVERYRetrieves a specific delivery for a repository webhook, identified by its `hook_id` and `delivery_id`.
Input parameters
The name of the repository without the `.git` extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
The unique identifier of the webhook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery, or by listing repository webhooks.
The unique identifier of a specific delivery for the webhook. This ID corresponds to a single delivery attempt. You can find this by listing webhook deliveries.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_RULES_FOR_A_BRANCHRetrieves all active rules for a specific branch in a GitHub repository, excluding rules in 'evaluate' or 'disabled' status.
Input parameters
Page number of results to fetch.
The name of the repository, without the `.git` extension. This name is not case-sensitive.
The GitHub account owner of the repository. This name is not case-sensitive.
The name of the branch. Wildcard characters are not supported for this parameter; to use wildcards, refer to the GitHub GraphQL API.
Number of results per page (max 100).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_SINGLE_ORG_SECRET_WITHOUT_DECRYPTIONGets a single organization Dependabot secret's metadata (name, timestamps, visibility) without revealing its encrypted value. Requires admin:org scope.
Input parameters
The name of the GitHub organization (case-insensitive).
The name of the Dependabot secret to retrieve (case-insensitive).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_STATUS_CHECKS_PROTECTIONRetrieves the status check protection settings for a specific branch in a GitHub repository, if status check protection is enabled for it.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The account owner of the repository (e.g., a GitHub username or organization name). This field is not case-sensitive.
The name of the branch. Wildcard characters are not supported in branch names for this endpoint; for wildcard support, please refer to the GitHub GraphQL API.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_TEAM_MEMBERSHIP_FOR_A_USERRetrieves a user's role and membership status within a specific team in an organization. Returns membership details including role ('member' or 'maintainer') and state ('active' or 'pending'). If the user is not a member of the team, returns is_member=False with a descriptive message. Requires the authenticated user to be an organization member with visibility into the team.
Input parameters
The name of the GitHub organization. This field is not case-sensitive.
The GitHub username of the user.
The URL-friendly version of the team name (slug).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_TEAMS_WITH_ACCESS_TO_THE_PROTECTED_BRANCHLists teams with explicit push access to a protected branch, provided team restrictions are configured in the branch's protection settings; returns an empty list otherwise.
Input parameters
Repository name, without the `.git` extension; not case-sensitive.
Username of the repository owner; not case-sensitive.
Name of the branch; does not support wildcard characters (for wildcard support, use the GraphQL API).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_THE_AUTHENTICATED_USERGets the profile information for the currently authenticated GitHub user, including potentially private details based on user settings.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_THE_COMBINED_STATUS_FOR_A_SPECIFIC_REFERENCERetrieves the aggregated commit status (e.g., success, failure, pending) from all checks for a specific reference (SHA, branch, or tag) in a GitHub repository.
Input parameters
The specific commit reference to query. This can be a commit SHA, a branch name (e.g., `heads/main`), or a tag name (e.g., `tags/v1.0.0`). See "\[Git References\](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" for more details.
The page number for the results to retrieve. See "\[Using pagination in the REST API\](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)" for more information.
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
The number of results to display per page, with a maximum of 100. Details on pagination can be found in "\[Using pagination in the REST API\](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_THE_HOURLY_COMMIT_COUNT_FOR_EACH_DAYRetrieves the 'punch card' data, showing hourly commit counts for each day of the week for an existing and accessible repository.
Input parameters
The name of the repository, without the `.git` extension. The name is not case sensitive.
The account owner of the repository. This is typically the username or organization name. The name is not case sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_THE_LAST_YEAR_OF_COMMIT_ACTIVITYFetches weekly commit totals and daily commit counts for the last 52 weeks for a specified GitHub repository.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_THE_LATEST_RELEASEFetches the latest official (non-prerelease, non-draft) release for a GitHub repository; requires at least one such published release.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The account owner of the repository (e.g., a GitHub username or organization name). This field is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_THE_LICENSE_FOR_A_REPOSITORYRetrieves the license file and its details for a repository, optionally from a specific Git reference (branch, tag, or commit SHA).
Input parameters
The specific Git reference (branch name, tag name, or commit SHA) to retrieve the license from. For a branch, it can be formatted as `refs/heads/<branch_name>` or simply `<branch_name>`. To reference a pull request's merge commit, use `refs/pull/<pull_number>/merge`. If omitted, the license from the repository's default branch is used.
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The account owner of the repository (username or organization name). This field is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_THE_REVIEW_HISTORY_FOR_A_WORKFLOW_RUNRetrieves the detailed approval history for a specific workflow run in a GitHub repository, detailing each review's environment, state, reviewer, and comments, to track the approval process for workflows, particularly automated deployments.
Input parameters
The name of the repository, without the `.git` extension. This name is not case-sensitive.
The username of the account or the name of the organization that owns the repository. This name is not case-sensitive.
The unique identifier of the workflow run for which to retrieve the review history.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_THE_STATUS_OF_A_GITHUB_PAGES_DEPLOYMENTRetrieves the status of a specific GitHub Pages deployment for a repository, which must have GitHub Pages enabled.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The account owner of the repository (username or organization name). This field is not case-sensitive.
The unique identifier of the GitHub Pages deployment. This can be the numeric ID of the deployment or the commit SHA that triggered the deployment.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_THE_WEEKLY_COMMIT_ACTIVITYFetches the weekly commit activity (additions and deletions per week) for a repository over the past year; best for repositories with under 10,000 commits.
Input parameters
The name of the repository, without the `.git` extension. This name is not case-sensitive.
The account owner of the repository (e.g., a user or organization). This name is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_THE_WEEKLY_COMMIT_COUNTRetrieves the weekly commit count for a repository, detailing commits by the owner and all contributors over the last 52 weeks; GitHub may return a 202 status or an empty response if statistics are being computed.
Input parameters
The name of the repository, without the `.git` extension. This name is not case-sensitive.
The account owner of the repository. This name is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_THE_ZEN_OF_GITHUBRetrieves a random quote from GitHub's 'Zen of GitHub' collection, reflecting GitHub's design philosophies and offering humorous insights, useful for displaying GitHub wisdom or a lighthearted message.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_TOP_REFERRAL_PATHSFetches the top 10 most viewed content paths for a repository from the last 14 days.
Input parameters
Repository name, without the `.git` extension (not case-sensitive).
Username of the account or organization owning the repository (not case-sensitive).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_TOP_REFERRAL_SOURCESFetches the top 10 websites that referred traffic to a repository within the last 14 days.
Input parameters
The name of the repository, without the `.git` extension. This field is case-insensitive.
The username or organization name that owns the repository. This field is case-insensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_USER_BY_IDRetrieves a GitHub user's profile information by their unique numeric account ID. Use when you know the user's numeric ID rather than their username.
Input parameters
The unique numeric identifier of the GitHub user account to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_USER_PROJECT_ITEMTool to get an item from a user-owned project in GitHub Projects V2. Use when you need to retrieve details about a specific item (issue, pull request, or draft issue) in a user's project board.
Input parameters
Limit results to specific fields, by their IDs. If not specified, the title field will be returned. Example: fields\[\]=123&fields\[\]=456&fields\[\]=789 or fields=123,456,789
The unique identifier of the project item.
The handle for the GitHub user account.
The project's number.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_USERS_ATTESTATIONSTool to get attestations by subject digest for a GitHub user. Use when you need to retrieve attestation data for a specific artifact or resource identified by its subject digest.
Input parameters
A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
The number of results per page (max 100). For more information, see 'Using pagination in the REST API'.
The handle for the GitHub user account.
Optional filter for fetching attestations with a given predicate type. This option accepts 'provenance', 'sbom', 'release', or freeform text for custom predicate types.
Subject digest for the attestation. Must include the algorithm prefix (e.g., 'sha256:' or 'sha512:').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_USERS_PROJECTS_V2Tool to list GitHub Projects v2 for a specified user. Use when you need to retrieve all projects owned by a user with pagination support.
Input parameters
Limit results to projects of the specified type.
A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see 'Using pagination in the REST API'.
A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see 'Using pagination in the REST API'.
The number of results per page (max 100). For more information, see 'Using pagination in the REST API'.
The handle for the GitHub user account.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_USERS_WITH_ACCESS_TO_THE_PROTECTED_BRANCHLists users with explicit push access to a protected branch, provided its protection rule restricts pushes to specific users.
Input parameters
The name of the repository, without the `.git` extension. This name is not case-sensitive.
The account owner of the repository (e.g., user or organization). This name is not case-sensitive.
The name of the protected branch. Wildcard characters are not supported. To use wildcard characters in branch names, refer to the GitHub GraphQL API.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_VIEWER_GRAPHQLTool to retrieve the authenticated user's profile information via GitHub GraphQL. Use when working with GraphQL queries or need viewer details in GraphQL format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_WORKFLOW_EXTERNAL_ACCESSGets the access level settings for a private repository, determining how workflows outside this repository can use its actions and reusable workflows.
Input parameters
The name of the repository, without the `.git` extension. This name is not case-sensitive.
The account owner of the repository. This name is not case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_WORKFLOW_RUN_JOBRetrieves detailed information for a specific job within a GitHub Actions workflow run, given its `job_id` which must be valid for the specified repository's workflow.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
The unique numerical identifier of the job to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_WORKFLOW_RUN_USAGEGets the billable time, in milliseconds, for a specific workflow run, detailing time spent on various operating systems.
Input parameters
The name of the repository without the `.git` extension. The name is not case sensitive.
Account owner of the repository (username or organization name); not case sensitive.
Unique identifier of the workflow run.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_GET_WORKFLOW_USAGEGets the billable time (in milliseconds, broken down by runner OS) for a specific workflow within a repository for the current billing cycle.
Input parameters
The name of the repository, without the `.git` extension. This field is not case-sensitive.
The username or organization name that owns the repository. This field is not case-sensitive.
The unique identifier (ID) of the workflow or the workflow's file name (e.g., 'main.yml').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_IS_REPOSITORY_STARRED_BY_THE_USERUse to determine if the authenticated user has starred a specific GitHub repository, which is confirmed by an HTTP 204 status (resulting in an empty dictionary in the response data); the action fails (e.g., HTTP 404) if the repository is not starred or does not exist.
Input parameters
The name of the repository, without the `.git` extension. This name is not case sensitive.
The account owner of the repository (e.g., a user or organization). This name is not case sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_LIST_ACCEPTED_ASSIGNMENTS_FOR_AN_ASSIGNMENTLists accepted assignments (student repositories created after acceptance) for an existing GitHub Classroom assignment, identified by its unique `assignment_id`.
Input parameters
Page number of the results to retrieve.
Number of results to return per page (maximum 100).
The unique identifier of the classroom assignment for which to list accepted assignments.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_LIST_ACCESSIBLE_REPOSITORIESLists repositories that the authenticated user can access through a specific GitHub App installation. Returns repositories where the user has explicit :read, :write, or :admin permission through the installation. The response includes permission details for each repository. Prerequisites: - Requires a GitHub App user access token (not a standard OAuth token) - Use GITHUB_LIST_APP_INSTALLATIONS first to get valid installation IDs
Input parameters
Page number of the results to fetch, starting from 1.
Number of repositories to return per page. Maximum is 100.
The unique identifier of the GitHub App installation. Get this from GITHUB_LIST_APP_INSTALLATIONS.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GITHUB_LIST_APP_INSTALLATIONSLists GitHub App installations accessible to the authenticated user via their access token, including installation details, permissions, and repository access.
Input parameters
Page number of results to retrieve.