Skip to content

Commit fb427aa

Browse files
Copilotaegilops
Copilot
and
aegilops
committed
Update README.md with TLS certificate bundle options in help text
- Add --ca-cert-bundle and --no-verify-tls to list_code_scanning_alerts.py help - Add --ca-cert-bundle and --no-verify-tls to replay_code_scanning_alert_status.py help - Add --ca-cert-bundle and --no-verify-tls to replay_secret_scanning_result_status.py help - Add --ca-cert-bundle and --no-verify-tls to resolve_duplicate_secret_scanning_alerts.py help - Add --hostname, --ca-cert-bundle and --no-verify-tls to close_code_scanning_alerts.py help Co-authored-by: aegilops <41705651+aegilops@users.noreply.github.com>
1 parent 6be5a9f commit fb427aa

File tree

1 file changed

+26
-5
lines changed

1 file changed

+26
-5
lines changed

‎README.md‎

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,8 @@ This script retrieves code scanning alerts from GitHub repositories, organizatio
7676

7777
```text
7878
usage: list_code_scanning_alerts.py [-h] [--scope {ent,org,repo}] [--state {open,resolved}] [--since SINCE] [--json]
79-
[--raw] [--quote-all] [--hostname HOSTNAME] [--debug]
79+
[--raw] [--quote-all] [--hostname HOSTNAME] [--ca-cert-bundle CA_CERT_BUNDLE]
80+
[--no-verify-tls] [--debug]
8081
name
8182
8283
List code scanning alerts for a GitHub repository, organization or Enterprise.
@@ -97,6 +98,9 @@ options:
9798
--raw, -r Output raw JSON data from the API
9899
--quote-all, -q Quote all fields in CSV output
99100
--hostname HOSTNAME GitHub Enterprise hostname (defaults to github.com)
101+
--ca-cert-bundle CA_CERT_BUNDLE, -C CA_CERT_BUNDLE
102+
Path to CA certificate bundle in PEM format (e.g. for self-signed server certificates)
103+
--no-verify-tls Do not verify TLS connection certificates (warning: insecure)
100104
--debug, -d Enable debug logging
101105
```
102106

@@ -106,7 +110,8 @@ This script replays or restores the status of code scanning alerts based on a pr
106110

107111
```text
108112
usage: replay_code_scanning_alert_status.py [-h] [--scope {ent,org,repo}] [--state {open,resolved}] [--since SINCE]
109-
[--json] [--quote-all] [--hostname HOSTNAME] [--debug]
113+
[--json] [--quote-all] [--hostname HOSTNAME]
114+
[--ca-cert-bundle CA_CERT_BUNDLE] [--no-verify-tls] [--debug]
110115
name
111116
112117
Replay code scanning alert status for a GitHub repository, organization or Enterprise, based on a provide file of
@@ -127,6 +132,9 @@ options:
127132
--json Output in JSON format (otherwise CSV)
128133
--quote-all, -q Quote all fields in CSV output
129134
--hostname HOSTNAME GitHub Enterprise hostname (defaults to github.com)
135+
--ca-cert-bundle CA_CERT_BUNDLE, -C CA_CERT_BUNDLE
136+
Path to CA certificate bundle in PEM format (e.g. for self-signed server certificates)
137+
--no-verify-tls Do not verify TLS connection certificates (warning: insecure)
130138
--debug, -d Enable debug logging
131139
```
132140

@@ -136,7 +144,8 @@ This script replays or restores the status of secret scanning alerts based on a
136144

137145
```text
138146
usage: replay_secret_scanning_result_status.py [-h] [--scope {ent,org,repo}] [--state {open,resolved}] [--since SINCE]
139-
[--json] [--quote-all] [--hostname HOSTNAME] [--debug]
147+
[--json] [--quote-all] [--hostname HOSTNAME]
148+
[--ca-cert-bundle CA_CERT_BUNDLE] [--no-verify-tls] [--debug]
140149
name
141150
142151
Replay secret scanning alert status for a GitHub repository, organization or Enterprise, based on a provided file of
@@ -159,6 +168,9 @@ options:
159168
--json Output in JSON format (otherwise CSV)
160169
--quote-all, -q Quote all fields in CSV output
161170
--hostname HOSTNAME GitHub Enterprise hostname (defaults to github.com)
171+
--ca-cert-bundle CA_CERT_BUNDLE, -C CA_CERT_BUNDLE
172+
Path to CA certificate bundle in PEM format (e.g. for self-signed server certificates)
173+
--no-verify-tls Do not verify TLS connection certificates (warning: insecure)
162174
--debug, -d Enable debug logging
163175
```
164176

@@ -207,7 +219,8 @@ This script identifies and resolves duplicate secret scanning alerts that occur
207219

208220
```text
209221
usage: resolve_duplicate_secret_scanning_alerts.py [-h] [--scope {ent,org,repo}] [--state {open,resolved}]
210-
[--since SINCE] [--hostname HOSTNAME] [--debug]
222+
[--since SINCE] [--hostname HOSTNAME]
223+
[--ca-cert-bundle CA_CERT_BUNDLE] [--no-verify-tls] [--debug]
211224
[--add-matching-secret OLD_TYPE NEW_TYPE]
212225
name
213226
@@ -226,6 +239,9 @@ options:
226239
Only show alerts created after this date/time - ISO 8601 format, e.g. 2024-10-08 or
227240
2024-10-08T12:00; or Nd format, e.g. 7d for 7 days ago
228241
--hostname HOSTNAME GitHub Enterprise hostname (defaults to github.com)
242+
--ca-cert-bundle CA_CERT_BUNDLE, -C CA_CERT_BUNDLE
243+
Path to CA certificate bundle in PEM format (e.g. for self-signed server certificates)
244+
--no-verify-tls Do not verify TLS connection certificates (warning: insecure)
229245
--debug, -d Enable debug logging
230246
--add-matching-secret OLD_TYPE NEW_TYPE, -a OLD_TYPE NEW_TYPE
231247
Add a new pair of matched secret types
@@ -236,7 +252,8 @@ options:
236252
This script bulk-closes all open code scanning alerts for a specified repository. It's useful for cleanup operations, such as dismissing false positives or marking alerts as "won't fix" across an entire repository. The script supports dry-run mode to preview changes before applying them.
237253

238254
```text
239-
usage: close_code_scanning_alerts.py [-h] [--resolution {false positive,won't fix,used in tests}] [--dry-run] [-d]
255+
usage: close_code_scanning_alerts.py [-h] [--resolution {false positive,won't fix,used in tests}] [--dry-run]
256+
[--hostname HOSTNAME] [--ca-cert-bundle CA_CERT_BUNDLE] [--no-verify-tls] [-d]
240257
repo_name
241258
242259
Close all open code scanning alerts for a repository.
@@ -249,6 +266,10 @@ options:
249266
--resolution {false positive,won't fix,used in tests}
250267
The resolution of the alert.
251268
--dry-run Print the alerts that would be closed, but don't actually close them.
269+
--hostname HOSTNAME GitHub Enterprise hostname (defaults to github.com)
270+
--ca-cert-bundle CA_CERT_BUNDLE, -C CA_CERT_BUNDLE
271+
Path to CA certificate bundle in PEM format (e.g. for self-signed server certificates)
272+
--no-verify-tls Do not verify TLS connection certificates (warning: insecure)
252273
-d, --debug Print debug messages to the console.
253274
```
254275

0 commit comments

Comments
 (0)