G
GithubApi
Arcade Native

GetGithubRepoRequiredWorkflow

GithubApi.GetGithubRepoRequiredWorkflow

Arcade Native Built and maintained by Arcade with full support
Supported by Arcade

Description

Retrieve a specific required workflow from a GitHub repository.

This tool fetches details of a required workflow from a specified GitHub repository. It can be used by anyone with read access to the repository. For private repositories, an access token with the 'repo' scope is needed. Useful for managing and auditing workflows in GitHub repositories.

Input Parameters

{
  "parameters": [
    {
      "name": "organization_name",
      "required": true,
      "inferrable": true,
      "description": "The name of the GitHub organization. It is not case sensitive.",
      "value_schema": {
        "val_type": "string"
      }
    },
    {
      "name": "repository_name",
      "required": true,
      "inferrable": true,
      "description": "The name of the GitHub repository. It is not case sensitive.",
      "value_schema": {
        "val_type": "string"
      }
    },
    {
      "name": "required_workflow_id",
      "required": true,
      "inferrable": true,
      "description": "The unique ID of the required workflow that has executed at least once in the repository.",
      "value_schema": {
        "val_type": "integer"
      }
    }
  ]
}

Output

{
  "description": "Response from the API endpoint 'actions/get-repo-required-workflow'.",
  "value_schema": {
    "val_type": "json"
  },
  "available_modes": [
    "value",
    "error"
  ]
}