Skip to content

Commit 910041b

Browse files
committed
Updated the read me with Jira details
1 parent 766e9b0 commit 910041b

File tree

3 files changed

+22
-2
lines changed

3 files changed

+22
-2
lines changed

README.md

+20
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,26 @@ If you don't want to provide the Socket API Token every time then you can use th
7676
| --timeout | False | | Timeout in seconds for API requests |
7777
| --include-module-folders | False | False | If enabled will include manifest files from folders like node_modules |
7878

79+
#### Plugins
80+
81+
The Python CLI currently Supports the following plugins:
82+
83+
- Jira
84+
85+
##### Jira
86+
87+
| Environment Variable | Required | Default | Description |
88+
|:------------------------|:---------|:--------|:-----------------------------------|
89+
| SOCKET_JIRA_ENABLED | False | false | Enables/Disables the Jira Plugin |
90+
| SOCKET_JIRA_CONFIG_JSON | True | None | Required if the Plugin is enabled. |
91+
92+
Example `SOCKET_JIRA_CONFIG_JSON` value
93+
94+
````json
95+
{"url": "https://REPLACE_ME.atlassian.net", "email": "[email protected]", "api_token": "REPLACE_ME", "project": "REPLACE_ME" }
96+
````
97+
98+
7999
## File Selection Behavior
80100

81101
The CLI determines which files to scan based on the following logic:

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
66

77
[project]
88
name = "socketsecurity"
9-
version = "2.0.49"
9+
version = "2.0.50"
1010
requires-python = ">= 3.10"
1111
license = {"file" = "LICENSE"}
1212
dependencies = [

socketsecurity/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
__author__ = 'socket.dev'
2-
__version__ = '2.0.49'
2+
__version__ = '2.0.50'

0 commit comments

Comments
 (0)