Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 6 additions & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ repos:
hooks:
- id: djlint-reformat-django
- id: djlint-django
- repo: https://github.com/phantomcyber/soar-app-linter
rev: 0.1.0
hooks:
- id: soar-app-linter
args: ["--single-repo", "--message-level", "error"]
- repo: https://github.com/hukkin/mdformat
rev: 0.7.22
hooks:
Expand All @@ -55,7 +60,7 @@ repos:
exclude: "README.md"
# Central hooks
- repo: https://github.com/phantomcyber/dev-cicd-tools
rev: v2.0.4
rev: v2.0.9
hooks:
- id: build-docs
language: python
Expand Down
2 changes: 2 additions & 0 deletions .pylintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[MASTER]
ignore=.venv
74 changes: 37 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# GitHub

Publisher: Splunk \
Connector Version: 2.1.1 \
Product Vendor: Microsoft \
Product Name: GitHub \
Publisher: Splunk <br>
Connector Version: 2.1.1 <br>
Product Vendor: Microsoft <br>
Product Name: GitHub <br>
Minimum Product Version: 5.5.0

This app integrates with GitHub to support various investigative and issue-based actions
Expand All @@ -22,29 +22,29 @@ VARIABLE | REQUIRED | TYPE | DESCRIPTION

### Supported Actions

[test connectivity](#action-test-connectivity) - Validate the asset configuration for connectivity using supplied configuration \
[list events](#action-list-events) - List events performed by a user \
[list users](#action-list-users) - List users of an organization \
[remove collaborator](#action-remove-collaborator) - Remove user as a collaborator from the repo \
[add collaborator](#action-add-collaborator) - Add user as a collaborator to repo \
[remove member](#action-remove-member) - Remove user from the team \
[add member](#action-add-member) - Add user in a team \
[list teams](#action-list-teams) - List all teams of an organization \
[list repos](#action-list-repos) - List all repos of an organization \
[list organizations](#action-list-organizations) - List all organizations \
[list issues](#action-list-issues) - Get a list of issues for the GitHub repository \
[list comments](#action-list-comments) - List comments for an issue on the GitHub repository \
[get issue](#action-get-issue) - Retrieve an issue for the GitHub repository \
[create issue](#action-create-issue) - Create an issue for the GitHub repository \
[update issue](#action-update-issue) - Update an issue for the GitHub repository \
[create comment](#action-create-comment) - Create a comment for an issue on the GitHub repository \
[test connectivity](#action-test-connectivity) - Validate the asset configuration for connectivity using supplied configuration <br>
[list events](#action-list-events) - List events performed by a user <br>
[list users](#action-list-users) - List users of an organization <br>
[remove collaborator](#action-remove-collaborator) - Remove user as a collaborator from the repo <br>
[add collaborator](#action-add-collaborator) - Add user as a collaborator to repo <br>
[remove member](#action-remove-member) - Remove user from the team <br>
[add member](#action-add-member) - Add user in a team <br>
[list teams](#action-list-teams) - List all teams of an organization <br>
[list repos](#action-list-repos) - List all repos of an organization <br>
[list organizations](#action-list-organizations) - List all organizations <br>
[list issues](#action-list-issues) - Get a list of issues for the GitHub repository <br>
[list comments](#action-list-comments) - List comments for an issue on the GitHub repository <br>
[get issue](#action-get-issue) - Retrieve an issue for the GitHub repository <br>
[create issue](#action-create-issue) - Create an issue for the GitHub repository <br>
[update issue](#action-update-issue) - Update an issue for the GitHub repository <br>
[create comment](#action-create-comment) - Create a comment for an issue on the GitHub repository <br>
[add labels](#action-add-labels) - Add label(s) to an issue on the GitHub repository

## action: 'test connectivity'

Validate the asset configuration for connectivity using supplied configuration

Type: **test** \
Type: **test** <br>
Read only: **True**

#### Action Parameters
Expand All @@ -59,7 +59,7 @@ No Output

List events performed by a user

Type: **investigate** \
Type: **investigate** <br>
Read only: **True**

Action will list a maximum of 300 events. Only events from the past 90 days will be listed.
Expand Down Expand Up @@ -2868,7 +2868,7 @@ summary.total_objects_successful | numeric | | 1 |

List users of an organization

Type: **investigate** \
Type: **investigate** <br>
Read only: **True**

#### Action Parameters
Expand Down Expand Up @@ -2912,7 +2912,7 @@ summary.total_objects_successful | numeric | | 1 |

Remove user as a collaborator from the repo

Type: **generic** \
Type: **generic** <br>
Read only: **False**

If the user is not a direct collaborator to the repo, any pending invitations to the user will also be deleted.
Expand Down Expand Up @@ -2943,7 +2943,7 @@ summary.total_objects_successful | numeric | | 1 |

Add user as a collaborator to repo

Type: **generic** \
Type: **generic** <br>
Read only: **False**

For repo whose owner is an organization, if the user is not a member of the organization, GitHub will send an email invite to the user to join as a collaborator. Otherwise, he will be directly added as a collaborator. For repo whose owner is a user, GitHub will always send an email invite to the user to join as a collaborator. If an invite is already sent to the user, re-invite will not be sent. If the user is already a collaborator, his role will be updated.
Expand Down Expand Up @@ -3021,7 +3021,7 @@ summary.total_objects_successful | numeric | | 1 |

Remove user from the team

Type: **generic** \
Type: **generic** <br>
Read only: **False**

Parameter 'organization name' is mandatory if the team name is provided instead of team ID.
Expand Down Expand Up @@ -3052,7 +3052,7 @@ summary.total_objects_successful | numeric | | 0 1 |

Add user in a team

Type: **generic** \
Type: **generic** <br>
Read only: **False**

Parameter 'organization name' is mandatory if the team name is provided instead of team ID.
Expand Down Expand Up @@ -3087,7 +3087,7 @@ summary.total_objects_successful | numeric | | 1 |

List all teams of an organization

Type: **investigate** \
Type: **investigate** <br>
Read only: **True**

#### Action Parameters
Expand Down Expand Up @@ -3123,7 +3123,7 @@ summary.total_objects_successful | numeric | | 1 |

List all repos of an organization

Type: **investigate** \
Type: **investigate** <br>
Read only: **True**

#### Action Parameters
Expand Down Expand Up @@ -3245,7 +3245,7 @@ summary.total_objects_successful | numeric | | 1 |

List all organizations

Type: **investigate** \
Type: **investigate** <br>
Read only: **True**

#### Action Parameters
Expand Down Expand Up @@ -3281,7 +3281,7 @@ summary.total_objects_successful | numeric | | 1 |

Get a list of issues for the GitHub repository

Type: **investigate** \
Type: **investigate** <br>
Read only: **True**

#### Action Parameters
Expand Down Expand Up @@ -3388,7 +3388,7 @@ summary.total_objects_successful | numeric | | 1 |

List comments for an issue on the GitHub repository

Type: **investigate** \
Type: **investigate** <br>
Read only: **True**

#### Action Parameters
Expand Down Expand Up @@ -3445,7 +3445,7 @@ summary.total_objects_successful | numeric | | 1 |

Retrieve an issue for the GitHub repository

Type: **investigate** \
Type: **investigate** <br>
Read only: **True**

#### Action Parameters
Expand Down Expand Up @@ -3548,7 +3548,7 @@ summary.total_objects_successful | numeric | | 1 |

Create an issue for the GitHub repository

Type: **generic** \
Type: **generic** <br>
Read only: **False**

Only users with push access can set assignees/labels for the issues.
Expand Down Expand Up @@ -3666,7 +3666,7 @@ summary.total_objects_successful | numeric | | 1 |

Update an issue for the GitHub repository

Type: **generic** \
Type: **generic** <br>
Read only: **False**

Only users with push access can set assignees/labels for new issues.
Expand Down Expand Up @@ -3807,7 +3807,7 @@ summary.total_objects_successful | numeric | | 1 |

Create a comment for an issue on the GitHub repository

Type: **generic** \
Type: **generic** <br>
Read only: **False**

#### Action Parameters
Expand Down Expand Up @@ -3865,7 +3865,7 @@ summary.total_objects_successful | numeric | | 1 |

Add label(s) to an issue on the GitHub repository

Type: **generic** \
Type: **generic** <br>
Read only: **False**

Only users with push access can set labels for the issues.
Expand Down
10 changes: 8 additions & 2 deletions github.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"publisher": "Splunk",
"license": "Copyright (c) 2019-2025 Splunk Inc.",
"app_version": "2.1.1",
"python_version": "3",
"python_version": "3.9, 3.13",
"fips_compliant": true,
"utctime_updated": "2021-04-28T23:08:45.000000Z",
"package_name": "phantom_github",
Expand Down Expand Up @@ -31229,5 +31229,11 @@
},
"versions": "EQ(*)"
}
]
],
"pip39_dependencies": {
"wheel": []
},
"pip313_dependencies": {
"wheel": []
}
}
7 changes: 1 addition & 6 deletions release_notes/unreleased.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
**Unreleased**
* Update Python dependencies for vulnerabilities, package updates, and platform built-in removals
* Update Python dependencies for Python 3.13 support
* Update NOTICE file with updated dependencies
* Apply pre-commit fixes
* chore(ci): update pre-commit config
* Resolved app issues related to Python 3.13 upgrade
* Remove beautifulsoup4 from requirements.txt
* Update Python version for 3.13
Loading