Feature: Improve workflow trigger command and add get-workflow-run command by jesusgpo · Pull Request #43755 · demisto/content

jesusgpo · 2026-04-01T07:45:35Z

Contributing to Cortex XSOAR Content

Make sure to register your contribution by filling the contribution registration form

The Pull Request will be reviewed only after the contribution registration form is filled.

Status

In Progress
Ready
In Hold - (Reason for hold)

Description

This PR improves the GitHub integration by updating the github-trigger-workflow command to use the latest GitHub REST API specification and adding a new github-get-workflow-run command.

github-trigger-workflow command

Updated Accept header from application/vnd.github.v3+json to application/vnd.github+json and added X-GitHub-Api-Version: 2026-03-10 to align with the current GitHub REST API versioning.
The API now returns a 200 response with the workflow run details. The command now returns a CommandResults object with outputs_prefix="GitHub.WorkflowRun" containing the triggered run data.
Added outputs to the YAML manifest: workflow_run_id, run_url, html_url.

New github-get-workflow-run command

Retrieves details of a specific workflow run by run_id.
Returns a CommandResults object with outputs_prefix="GitHub.WorkflowRun" and outputs: id, name, head_branch, head_sha, display_title, run_number, event, status, conclusion, workflow_id, url, html_url, created_at, updated_at.
Registered in both the deprecated (GitHub-get-workflow-run) and current (github-get-workflow-run) command sections of the YAML manifest.

Must have

Tests
Documentation

relates: https://jira-dc.paloaltonetworks.com/browse/CIAC-16455

content-bot · 2026-04-01T07:47:22Z

Thank you for your contribution. Your generosity and caring are unrivaled! Make sure to register your contribution by filling the Contribution Registration form, so our content wizard @kamalq97 will know the proposed changes are ready to be reviewed.
For your convenience, here is a link to the contributions SLAs document.

content-bot · 2026-04-01T07:47:24Z

Hi @jesusgpo, thanks for contributing to the XSOAR marketplace. To receive credit for your generous contribution please follow this link.

content-bot · 2026-04-01T07:47:26Z

🤖 AI-Powered Code Review Available

Hi @kamalq97, you can leverage AI-powered code review to assist with this PR!

Available Commands:

@marketplace-ai-reviewer start review - Initiate a full AI code review
@marketplace-ai-reviewer re-review - Incremental review for new commits

Copilot

Pull request overview

This PR updates the GitHub integration’s workflow functionality by modernizing the github-trigger-workflow request headers and introducing a new command to retrieve workflow run details (github-get-workflow-run), including YAML output definitions and unit tests.

Changes:

Update github-trigger-workflow to send newer GitHub REST headers and attempt to return workflow run data.
Add github-get-workflow-run / GitHub-get-workflow-run command to fetch a workflow run by run_id.
Add test data + unit test coverage for the new command, and update the trigger-workflow test description.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.

File	Description
Packs/GitHub/Integrations/GitHub/GitHub.py	Updates trigger-workflow behavior/headers and adds the get-workflow-run command implementation + command registration.
Packs/GitHub/Integrations/GitHub/GitHub.yml	Adds output schemas for trigger-workflow and registers the new get-workflow-run command (deprecated + canonical).
Packs/GitHub/Integrations/GitHub/GitHub_test.py	Adds a unit test for get-workflow-run and updates the trigger-workflow test description.
Packs/GitHub/Integrations/GitHub/test_data/get_workflow_run_response.json	Adds a sample workflow-run JSON response for tests.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Packs/GitHub/Integrations/GitHub/GitHub.py

Packs/GitHub/Integrations/GitHub/GitHub_test.py

Packs/GitHub/Integrations/GitHub/GitHub.yml

jesusgpo · 2026-04-01T07:49:26Z

@marketplace-ai-reviewer start review

marketplace-ai-reviewer · 2026-04-01T07:50:58Z

🤖 Analysis started. Please wait for results...

marketplace-ai-reviewer · 2026-04-01T07:59:00Z

🤖 AI Review Disclaimer

This review was generated by an AI-powered tool and may contain inaccuracies. Please be advised, and we extend our sincere apologies for any inconvenience this may cause.

marketplace-ai-reviewer

Hi! Thanks for your contribution to the GitHub integration. I've left a few notes on the PR, primarily regarding standardizing context output keys to PascalCase and fixing a typo in the API version headers. You'll also need to update a couple of outdated test assertions, add date format examples to the YAML descriptions, and remove an unnecessary deprecated command. Thanks again for your work!

@kamalq97, @copilot-pull-request-reviewer[bot] please review and approve the results generated by the AI Reviewer by responding 👍 on this comment.

Packs/GitHub/Integrations/GitHub/GitHub.py

marketplace-ai-reviewer · 2026-04-01T07:58:57Z

Packs/GitHub/Integrations/GitHub/GitHub.py

    response = http_request("POST", url_suffix=suffix, headers=headers, data=data)
+    return_results(CommandResults(
+        outputs_prefix="GitHub.WorkflowRun",
+        outputs_key_field="workflow_run_id",


Inconsistent outputs_key_field for GitHub.WorkflowRun

The outputs_key_field for GitHub.WorkflowRun is still inconsistent. In github_trigger_workflow_command it is set to WorkflowRunID, while in github_get_workflow_run_command it is set to ID. To ensure the context data is merged correctly, both commands should use the exact same key field (e.g., both should use ID or both should use WorkflowRunID).

Packs/GitHub/Integrations/GitHub/GitHub.py

Packs/GitHub/Integrations/GitHub/GitHub_test.py

Packs/GitHub/Integrations/GitHub/GitHub.yml

Packs/GitHub/Integrations/GitHub/GitHub.py

* Reformatted the return statement in `github_trigger_workflow_command` for better clarity. * Removed unused import `github_get_workflow_run_command` from the test file.

…ts' into feature/github-workfow-runs-improvements

jesusgpo · 2026-04-09T06:15:31Z

@kamalq97 hello how are you? For us, it is no longer viable to contribute to the community if implementing an improvement takes so long, we have developments pending ...

kamalq97 · 2026-04-12T14:02:24Z

Hi @jesusgpo

Thank you once again for your contribution.

The PR has been assigned to member of the team for review.

Please note that the team currently has a large number of contributions to review. New contributions may experience a slight delay while we work on clearing the backlog.

Thank you for the patience and we hope you can remain a valuable member of our community.

marketplace-ai-reviewer · 2026-04-13T17:01:21Z

🤖 Analysis started. Please wait for results...

barryyosi-panw · 2026-04-13T17:23:16Z

Hi @jesusgpo, since the GitHub integration was recently updated, please make sure to update your forked repo and branch.

marketplace-ai-reviewer · 2026-04-13T17:31:44Z

🤖 AI Review Disclaimer

This review was generated by an AI-powered tool and may contain inaccuracies. Please be advised, and we extend our sincere apologies for any inconvenience this may cause.

marketplace-ai-reviewer

🔄 Re-reviewing updates...

Important

To maintain review integrity, threads marked as Resolved without accompanying changes or explanations will be automatically unresolved for further verification.

Thanks for your contribution to the GitHub pack! I've reviewed the PR and found a few adjustments needed, specifically around verifying the GitHub API version headers and adding the missing deprecated command mapping. Please also ensure the outputs_key_field is consistent (updating tests if needed), add the vendor name to the metadata keywords, and use approved prefixes in your release notes. Let me know if you have any questions!

Additionally, please address the following file-level notes:

Packs/GitHub/Integrations/GitHub/GitHub.py: Invalid GitHub API version in headers
Packs/GitHub/pack_metadata.json: The vendor name must appear in the keywords field.

@barryyosi-panw, @marketplace-ai-reviewer, @copilot-pull-request-reviewer[bot], @jesusgpo please review and approve the results generated by the AI Reviewer by responding 👍 on this comment.

marketplace-ai-reviewer · 2026-04-13T17:31:41Z

Packs/GitHub/Integrations/GitHub/GitHub.py


    suffix = f"/repos/{owner}/{repository}/actions/workflows/{workflow}/dispatches"
-    headers = {"Authorization": f"Bearer {TOKEN}", "Accept": "application/vnd.github.v3+json"}
+    headers = {"Authorization": f"Bearer {TOKEN}", "Accept": "application/vnd.github+json", "X-GitHub-Api-Version": "2026-03-10"}


Verify the X-GitHub-Api-Version header value

marketplace-ai-reviewer · 2026-04-13T17:31:41Z

Packs/GitHub/Integrations/GitHub/GitHub.py

+    # http_request returns a dict for 200 (JSON body) and a Response object for 204 No Content.
+    if isinstance(response, dict):
+        outputs = {
+            "WorkflowRunID": response.get("workflow_run_id") or response.get("id"),


Inconsistent outputs_key_field for GitHub.WorkflowRun

marketplace-ai-reviewer · 2026-04-13T17:31:41Z

Packs/GitHub/Integrations/GitHub/GitHub_test.py

+    mocker_results.assert_called_once()
+    result: CommandResults = mocker_results.call_args[0][0]
+    assert result.outputs_prefix == "GitHub.WorkflowRun"
+    assert result.outputs["WorkflowRunID"] == 9876


Update test assertion if WorkflowRunID is changed to ID

marketplace-ai-reviewer · 2026-04-13T17:31:41Z

Packs/GitHub/ReleaseNotes/2_2_6.md

+
+##### GitHub
+
+- Updated command **_github-trigger-workflow_** to support workflow runs that return a JSON body (HTTP 200), in addition to the standard 204 No Content response. When run details are returned, they are stored in the `GitHub.WorkflowRun` context with the following fields: `WorkflowRunID`, `RunUrl`, and `HtmlUrl`.


The release note entry does not start with an approved prefix. Please use an approved prefix such as Updated the.

marketplace-ai-reviewer · 2026-04-13T17:31:41Z

Packs/GitHub/ReleaseNotes/2_2_6.md

+##### GitHub
+
+- Updated command **_github-trigger-workflow_** to support workflow runs that return a JSON body (HTTP 200), in addition to the standard 204 No Content response. When run details are returned, they are stored in the `GitHub.WorkflowRun` context with the following fields: `WorkflowRunID`, `RunUrl`, and `HtmlUrl`.
+- Added new command **_github-get-workflow-run_** to retrieve details of a specific workflow run by its ID. Outputs are stored in `GitHub.WorkflowRun` with fields: `ID`, `Name`, `HeadBranch`, `HeadSha`, `DisplayTitle`, `RunNumber`, `Event`, `Status`, `Conclusion`, `WorkflowID`, `CreatedAt`, `UpdatedAt`, `Url`, and `HtmlUrl`.


The release note entry does not start with an approved prefix. Please use an approved prefix such as Added the.

jesusgpo added 2 commits April 1, 2026 09:34

feat: improve workflow trigger command to return run details

d1d830e

feat: add get-workflow-run command

70663a9

Copilot AI review requested due to automatic review settings April 1, 2026 07:45

Copilot started reviewing on behalf of jesusgpo April 1, 2026 07:46 View session

content-bot added Contribution Thank you! Contributions are always welcome! External PR Xsoar Support Level Indicates that the contribution is for XSOAR supported pack labels Apr 1, 2026

content-bot changed the base branch from master to contrib/jesusgpo_feature/github-workfow-runs-improvements April 1, 2026 07:47

content-bot assigned kamalq97 Apr 1, 2026

content-bot requested a review from kamalq97 April 1, 2026 07:47

Copilot AI reviewed Apr 1, 2026

View reviewed changes

content-bot added Community Contribution Form Filled Whether contribution form filled or not. labels Apr 1, 2026

chore: contributors update

3d22fd3

marketplace-ai-reviewer reviewed Apr 1, 2026

View reviewed changes

feat: manage 200 and 204 in trigger workflow

4c5e58c

jesusgpo commented Apr 1, 2026

View reviewed changes

Packs/GitHub/Integrations/GitHub/GitHub.py Show resolved Hide resolved

jesusgpo commented Apr 1, 2026

View reviewed changes

Packs/GitHub/Integrations/GitHub/GitHub.py Show resolved Hide resolved

jesusgpo added 4 commits April 1, 2026 10:59

refactor: camelCase renaming

4f1256a

chore: update release

6b7cfc9

refactor: remove innecesary deprecated get-workflow-run command

84f5b2b

refactor: update iso date format

702b3cc

jesusgpo commented Apr 1, 2026

View reviewed changes

Packs/GitHub/Integrations/GitHub/GitHub.py Show resolved Hide resolved

refactor: escape yml

0f12f67

jesusgpo and others added 2 commits April 7, 2026 08:59

refactor: Improve code readability in GitHub integration

787f209

* Reformatted the return statement in `github_trigger_workflow_command` for better clarity. * Removed unused import `github_get_workflow_run_command` from the test file.

Merge branch 'contrib/jesusgpo_feature/github-workfow-runs-improvemen…

244b2a7

…ts' into feature/github-workfow-runs-improvements

kamalq97 requested a review from barryyosi-panw April 12, 2026 14:02

kamalq97 assigned barryyosi-panw and unassigned kamalq97 Apr 12, 2026

kamalq97 removed their request for review April 12, 2026 14:02

demisto deleted a comment from marketplace-ai-reviewer Apr 13, 2026

barryyosi-panw added the ready-for-ai-review The PR is ready for reviewing the PR with the AI Reviewer. label Apr 13, 2026

marketplace-ai-reviewer removed the ready-for-ai-review The PR is ready for reviewing the PR with the AI Reviewer. label Apr 13, 2026

marketplace-ai-reviewer reviewed Apr 13, 2026

View reviewed changes


		##### GitHub

		- Updated command _github-trigger-workflow_ to support workflow runs that return a JSON body (HTTP 200), in addition to the standard 204 No Content response. When run details are returned, they are stored in the `GitHub.WorkflowRun` context with the following fields: `WorkflowRunID`, `RunUrl`, and `HtmlUrl`.

Conversation

jesusgpo commented Apr 1, 2026 • edited by kamalq97 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Contributing to Cortex XSOAR Content

Status

Description

Must have

Uh oh!

content-bot commented Apr 1, 2026

Uh oh!

content-bot commented Apr 1, 2026

Uh oh!

content-bot commented Apr 1, 2026

🤖 AI-Powered Code Review Available

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jesusgpo commented Apr 1, 2026

Uh oh!

marketplace-ai-reviewer commented Apr 1, 2026

Uh oh!

marketplace-ai-reviewer commented Apr 1, 2026

Uh oh!

marketplace-ai-reviewer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

marketplace-ai-reviewer Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

marketplace-ai-reviewer Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jesusgpo commented Apr 9, 2026

Uh oh!

kamalq97 commented Apr 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

marketplace-ai-reviewer commented Apr 13, 2026

Uh oh!

barryyosi-panw commented Apr 13, 2026

Uh oh!

marketplace-ai-reviewer commented Apr 13, 2026

Uh oh!

marketplace-ai-reviewer left a comment

Choose a reason for hiding this comment

🔄 Re-reviewing updates...

Uh oh!

marketplace-ai-reviewer Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

marketplace-ai-reviewer Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

marketplace-ai-reviewer Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

marketplace-ai-reviewer Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

jesusgpo commented Apr 1, 2026 •

edited by kamalq97

Loading

kamalq97 commented Apr 12, 2026 •

edited

Loading