diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index a8df7c5..fe86072 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -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:
@@ -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
diff --git a/.pylintrc b/.pylintrc
new file mode 100644
index 0000000..fcbba09
--- /dev/null
+++ b/.pylintrc
@@ -0,0 +1,2 @@
+[MASTER]
+ignore=.venv
diff --git a/README.md b/README.md
index 119c40a..47f0daa 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
# GitHub
-Publisher: Splunk \
-Connector Version: 2.1.1 \
-Product Vendor: Microsoft \
-Product Name: GitHub \
+Publisher: Splunk
+Connector Version: 2.1.1
+Product Vendor: Microsoft
+Product Name: GitHub
Minimum Product Version: 5.5.0
This app integrates with GitHub to support various investigative and issue-based actions
@@ -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
+[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
[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**
Read only: **True**
#### Action Parameters
@@ -59,7 +59,7 @@ No Output
List events performed by a user
-Type: **investigate** \
+Type: **investigate**
Read only: **True**
Action will list a maximum of 300 events. Only events from the past 90 days will be listed.
@@ -2868,7 +2868,7 @@ summary.total_objects_successful | numeric | | 1 |
List users of an organization
-Type: **investigate** \
+Type: **investigate**
Read only: **True**
#### Action Parameters
@@ -2912,7 +2912,7 @@ summary.total_objects_successful | numeric | | 1 |
Remove user as a collaborator from the repo
-Type: **generic** \
+Type: **generic**
Read only: **False**
If the user is not a direct collaborator to the repo, any pending invitations to the user will also be deleted.
@@ -2943,7 +2943,7 @@ summary.total_objects_successful | numeric | | 1 |
Add user as a collaborator to repo
-Type: **generic** \
+Type: **generic**
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.
@@ -3021,7 +3021,7 @@ summary.total_objects_successful | numeric | | 1 |
Remove user from the team
-Type: **generic** \
+Type: **generic**
Read only: **False**
Parameter 'organization name' is mandatory if the team name is provided instead of team ID.
@@ -3052,7 +3052,7 @@ summary.total_objects_successful | numeric | | 0 1 |
Add user in a team
-Type: **generic** \
+Type: **generic**
Read only: **False**
Parameter 'organization name' is mandatory if the team name is provided instead of team ID.
@@ -3087,7 +3087,7 @@ summary.total_objects_successful | numeric | | 1 |
List all teams of an organization
-Type: **investigate** \
+Type: **investigate**
Read only: **True**
#### Action Parameters
@@ -3123,7 +3123,7 @@ summary.total_objects_successful | numeric | | 1 |
List all repos of an organization
-Type: **investigate** \
+Type: **investigate**
Read only: **True**
#### Action Parameters
@@ -3245,7 +3245,7 @@ summary.total_objects_successful | numeric | | 1 |
List all organizations
-Type: **investigate** \
+Type: **investigate**
Read only: **True**
#### Action Parameters
@@ -3281,7 +3281,7 @@ summary.total_objects_successful | numeric | | 1 |
Get a list of issues for the GitHub repository
-Type: **investigate** \
+Type: **investigate**
Read only: **True**
#### Action Parameters
@@ -3388,7 +3388,7 @@ summary.total_objects_successful | numeric | | 1 |
List comments for an issue on the GitHub repository
-Type: **investigate** \
+Type: **investigate**
Read only: **True**
#### Action Parameters
@@ -3445,7 +3445,7 @@ summary.total_objects_successful | numeric | | 1 |
Retrieve an issue for the GitHub repository
-Type: **investigate** \
+Type: **investigate**
Read only: **True**
#### Action Parameters
@@ -3548,7 +3548,7 @@ summary.total_objects_successful | numeric | | 1 |
Create an issue for the GitHub repository
-Type: **generic** \
+Type: **generic**
Read only: **False**
Only users with push access can set assignees/labels for the issues.
@@ -3666,7 +3666,7 @@ summary.total_objects_successful | numeric | | 1 |
Update an issue for the GitHub repository
-Type: **generic** \
+Type: **generic**
Read only: **False**
Only users with push access can set assignees/labels for new issues.
@@ -3807,7 +3807,7 @@ summary.total_objects_successful | numeric | | 1 |
Create a comment for an issue on the GitHub repository
-Type: **generic** \
+Type: **generic**
Read only: **False**
#### Action Parameters
@@ -3865,7 +3865,7 @@ summary.total_objects_successful | numeric | | 1 |
Add label(s) to an issue on the GitHub repository
-Type: **generic** \
+Type: **generic**
Read only: **False**
Only users with push access can set labels for the issues.
diff --git a/github.json b/github.json
index 1a65b9b..b6d0d42 100644
--- a/github.json
+++ b/github.json
@@ -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",
@@ -31229,5 +31229,11 @@
},
"versions": "EQ(*)"
}
- ]
+ ],
+ "pip39_dependencies": {
+ "wheel": []
+ },
+ "pip313_dependencies": {
+ "wheel": []
+ }
}
diff --git a/release_notes/unreleased.md b/release_notes/unreleased.md
index b85ef6f..1de3f0e 100644
--- a/release_notes/unreleased.md
+++ b/release_notes/unreleased.md
@@ -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