Github Actions Trigger

🚀 GitHub Actions Guide

This guide provides detailed instructions on using various tools to interact with GitHub Actions, enabling you to automate your development workflows effectively.

🚀 Quick Start

🔍 Get GitHub Action Information

Use the get_github_action tool to obtain detailed information about a specific GitHub Action.

Request Format

{
  "owner": "actions",
  "repo": "checkout",
  "ref": "v4"
}

Response Example

{
  "name": "Checkout",
  "description": "Check out a Git repository at a particular version",
  "author": "GitHub",
  "inputs": [
    {
      "name": "repository",
      "description": "Repository name with owner. For example, actions/checkout",
      "default": "",
      "required": false
    },
    {
      "name": "ref",
      "description": "The branch, tag or SHA to checkout.",
      "default": "",
      "required": false
    }
  ],
  "runs": {
    "using": "node20",
    "main": "dist/index.js"
  }
}

🚀 Trigger GitHub Workflow

Use the trigger_github_action tool to trigger a specific GitHub workflow.

Request Format

{
  "owner": "username-or-org",
  "repo": "repository-name",
  "workflow_id": "ci.yml",
  "inputs": {
    "deploy_environment": "production",
    "debug_enabled": "true"
  }
}

Response Example

{
  "success": true,
  "message": "Workflow dispatch event triggered successfully",
  "run": {
    "id": 12345678,
    "url": "https://github.com/owner/repo/actions/runs/12345678",
    "status": "queued",
    "conclusion": null,
    "created_at": "2025-03-19T06:45:12Z",
    "triggered_by": "API"
  }
}

Important Note

1. The workflow must be configured to support the workflow_dispatch event.
2. The GitHub token must have the workflow scope permission.
3. The input parameters must match those defined in the workflow.

🔎 Get GitHub Actions in a Repository

Use the get_github_actions tool to list all available GitHub Actions in a specific repository.

Request Format

{
  "owner": "actions",
  "repo": "checkout"
}

Response Example

{
  "count": 1,
  "actions": [
    {
      "name": "Checkout",
      "description": "Check out a Git repository at a particular version",
      "author": "GitHub",
      "inputs": [
        {
          "name": "repository",
          "description": "Repository name with owner. For example, actions/checkout",
          "default": "",
          "required": false
        },
        {
          "name": "ref",
          "description": "The branch, tag or SHA to checkout.",
          "default": "",
          "required": false
        }
      ],
      "runs": {
        "using": "node20",
        "main": "dist/index.js"
      }
    }
  ]
}

📦 Get the Latest Two Releases

Use the get_github_release tool to obtain the latest two release versions of a repository.

Request Format

{
  "owner": "actions/runner",
  "repo": "runners"
}

Response Example

[
  {
    "tag_name": "2.286.0",
    "name": "GitHub Hosted Runner for Windows release 2.286.0",
    "body": "New release of GitHub Hosted Runner for Windows.",
    "published_at": "2024-03-19T15:00:00Z"
  },
  {
    "tag_name": "2.285.0",
    "name": "GitHub Hosted Runner for Windows release 2.285.0",
    "body": "New release of GitHub Hosted Runner for Windows.",
    "published_at": "2024-03-18T15:00:00Z"
  }
]

Usage Tip

• By default, the tool returns the latest two release versions.
• Adjust the request parameters if you need more or fewer release versions.

In summary, this guide offers a comprehensive overview of GitHub Actions. By leveraging these tools and examples, you can gain a better understanding and effectively utilize GitHub Actions to automate your development processes.