Skip to content

feat: return workflow artifact contents from actions_get #2677

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rodboev wants to merge 1 commit into
base: main
Choose a base branch
from
+651 −14
Open

feat: return workflow artifact contents from actions_get #2677

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -591,15 +591,19 @@ The following sets of tools are available:

- **actions_get** - Get details of GitHub Actions resources (workflows, workflow runs, jobs, and artifacts)
- **Required OAuth Scopes**: `repo`
- `artifact_name`: Exact workflow artifact name to resolve within 'run_id' for 'download_workflow_run_artifact'. (string, optional)
- `max_bytes`: Maximum number of bytes of text content to return per file when extracting 'download_workflow_run_artifact'. Defaults to 65536. (number, optional)
- `method`: The method to execute (string, required)
- `owner`: Repository owner (string, required)
- `path`: Optional exact file path inside the artifact ZIP to return for 'download_workflow_run_artifact'. (string, optional)
- `repo`: Repository name (string, required)
- `resource_id`: The unique identifier of the resource. This will vary based on the "method" provided, so ensure you provide the correct ID:
- Provide a workflow ID or workflow file name (e.g. ci.yaml) for 'get_workflow' method.
- Provide a workflow run ID for 'get_workflow_run', 'get_workflow_run_usage', and 'get_workflow_run_logs_url' methods.
- Provide an artifact ID for 'download_workflow_run_artifact' method.
- Provide an artifact ID for 'download_workflow_run_artifact' to get a temporary download URL, or omit it and use 'run_id' plus 'artifact_name' to return artifact contents.
- Provide a job ID for 'get_workflow_job' method.
(string, required)
(string, optional)
- `run_id`: Workflow run ID used with 'artifact_name' to resolve and extract an artifact for 'download_workflow_run_artifact'. (number, optional)

- **actions_list** - List GitHub Actions workflows in a repository
- **Required OAuth Scopes**: `repo`
Expand Down
23 changes: 20 additions & 3 deletions pkg/github/__toolsnaps__/actions_get.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,16 @@
"description": "Get details about specific GitHub Actions resources.\nUse this tool to get details about individual workflows, workflow runs, jobs, and artifacts by their unique IDs.\n",
"inputSchema": {
"properties": {
"artifact_name": {
"description": "Exact workflow artifact name to resolve within 'run_id' for 'download_workflow_run_artifact'.",
"type": "string"
},
"max_bytes": {
"default": 65536,
"description": "Maximum number of bytes of text content to return per file when extracting 'download_workflow_run_artifact'. Defaults to 65536.",
"minimum": 1,
"type": "number"
},
"method": {
"description": "The method to execute",
"enum": [
Expand All @@ -22,20 +32,27 @@
"description": "Repository owner",
"type": "string"
},
"path": {
"description": "Optional exact file path inside the artifact ZIP to return for 'download_workflow_run_artifact'.",
"type": "string"
},
"repo": {
"description": "Repository name",
"type": "string"
},
"resource_id": {
"description": "The unique identifier of the resource. This will vary based on the \"method\" provided, so ensure you provide the correct ID:\n- Provide a workflow ID or workflow file name (e.g. ci.yaml) for 'get_workflow' method.\n- Provide a workflow run ID for 'get_workflow_run', 'get_workflow_run_usage', and 'get_workflow_run_logs_url' methods.\n- Provide an artifact ID for 'download_workflow_run_artifact' method.\n- Provide a job ID for 'get_workflow_job' method.\n",
"description": "The unique identifier of the resource. This will vary based on the \"method\" provided, so ensure you provide the correct ID:\n- Provide a workflow ID or workflow file name (e.g. ci.yaml) for 'get_workflow' method.\n- Provide a workflow run ID for 'get_workflow_run', 'get_workflow_run_usage', and 'get_workflow_run_logs_url' methods.\n- Provide an artifact ID for 'download_workflow_run_artifact' to get a temporary download URL, or omit it and use 'run_id' plus 'artifact_name' to return artifact contents.\n- Provide a job ID for 'get_workflow_job' method.\n",
"type": "string"
},
"run_id": {
"description": "Workflow run ID used with 'artifact_name' to resolve and extract an artifact for 'download_workflow_run_artifact'.",
"type": "number"
}
},
"required": [
"method",
"owner",
"repo",
"resource_id"
"repo"
],
"type": "object"
},
Expand Down
Loading