You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update CI integrations with the new scan timeout parameter (#583)
* Update CI integrations with the new scan timeout parameter
* Update github-action.mdx
* Apply suggestions from code review
Co-authored-by: Zoltan David <[email protected]>
* Update website/docs/advanced/code-references/circleci-orb.mdx
Co-authored-by: Zoltan David <[email protected]>
---------
Co-authored-by: Zoltan David <[email protected]>
Copy file name to clipboardExpand all lines: website/docs/advanced/code-references/bitbucket-pipe.mdx
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,10 +18,11 @@ You can find more information about Bitbucket Pipelines <a target="_blank" href=
18
18
Don't forget to replace the `PASTE-YOUR-CONFIG-ID-HERE` value with your actual Config ID.
19
19
20
20
```yaml
21
-
- pipe: configcat/scan-repository-pipe:1.8.0
21
+
- pipe: configcat/scan-repository-pipe:1.8.1
22
22
variables:
23
23
CONFIG_ID: 'PASTE-YOUR-CONFIG-ID-HERE'
24
24
# LINE_COUNT: '3' # optional
25
+
# TIMEOUT: '1800' # optional
25
26
# SUB_FOLDER: '/src' # optional
26
27
# EXCLUDE_KEYS: > # optional
27
28
# flag_key_to_exclude_1
@@ -42,6 +43,7 @@ Scan reports are uploaded for each branch of your repository that triggers the j
42
43
|`CONFIG_ID `| ID of the ConfigCat config to scan against. |☑||
43
44
|`CONFIGCAT_API_HOST`| ConfigCat Management API host. ||`api.configcat.com`|
44
45
|`LINE_COUNT`| Context line count before and after the reference line. (min: 1, max: 10) || 4 |
46
+
|`TIMEOUT`| Scan timeout in seconds (default: 1800, min: 60). If the scan does not finish within this time, it is aborted. No partial results are returned. The command exits with a timeout error. || 1800 |
45
47
|`SUB_FOLDER`| Sub-folder to scan, relative to the repository root folder. |||
46
48
|`EXCLUDE_KEYS`| List of feature flag keys that must be excluded from the scan report. |||
47
49
|`ALIAS_PATTERNS`| Comma delimited list of custom regex patterns used to search for additional aliases. |||
@@ -56,6 +57,7 @@ Scan reports are uploaded for each branch of your repository that triggers the w
56
57
|`file-url-template`| Template url used to generate VCS file links. Available template parameters: `commitHash`, `filePath`, `lineNumber`. Example: `https://github.com/my/repo/blob/{commitHash}/{filePath}#L{lineNumber}`|||
57
58
|`commit-url-template`| Template url used to generate VCS commit links. Available template parameters: `commitHash`. Example: `https://github.com/my/repo/commit/{commitHash}`|||
58
59
|`line-count`| Context line count before and after the reference line. (min: 1, max: 10) || 4 |
60
+
|`timeout`| Scan timeout in seconds (default: 1800, min: 60). If the scan does not finish within this time, it is aborted. No partial results are returned. The command exits with a timeout error. || 1800 |
59
61
|`sub-folder`| Sub-folder to scan, relative to the repository root folder. |||
60
62
|`exclude-keys`| List of feature flag keys that must be excluded from the scan report. |||
61
63
|`alias-patterns`| Comma delimited list of custom regex patterns used to search for additional aliases. |||
Copy file name to clipboardExpand all lines: website/docs/advanced/code-references/github-action.mdx
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,6 +33,7 @@ You can find more information about GitHub Actions <a target="_blank" href="http
33
33
api-pass: ${{ secrets.CONFIGCAT_API_PASS }}
34
34
config-id: PASTE-YOUR-CONFIG-ID-HERE
35
35
# line-count: 5 # optional
36
+
# timeout: 1800 # optional
36
37
# sub-folder: src # optional
37
38
# exclude-keys: > # optional
38
39
# flag_key_to_exclude_1
@@ -56,6 +57,7 @@ Scan reports are uploaded for each branch of your repository that triggers the w
56
57
|`api-pass`| <atarget="_blank"href="https://app.configcat.com/my-account/public-api-credentials">ConfigCat Management API basic authentication password</a>. |☑||
57
58
|`api-host`| ConfigCat Management API host. ||`api.configcat.com`|
58
59
|`line-count`| Context line count before and after the reference line. (min: 1, max: 10) || 4 |
60
+
|`timeout`| Scan timeout in seconds (default: 1800, min: 60). If the scan does not finish within this time, it is aborted. No partial results are returned. The command exits with a timeout error. || 1800 |
59
61
|`sub-folder`| Sub-folder to scan, relative to the repository root folder. |||
60
62
|`exclude-keys`| List of feature flag keys that must be excluded from the scan report. |||
61
63
|`alias-patterns`| Comma delimited list of custom regex patterns used to search for additional aliases. |||
Copy file name to clipboardExpand all lines: website/versioned_docs/version-V1/advanced/code-references/bitbucket-pipe.mdx
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,10 +18,11 @@ You can find more information about Bitbucket Pipelines <a target="_blank" href=
18
18
Don't forget to replace the `PASTE-YOUR-CONFIG-ID-HERE` value with your actual Config ID.
19
19
20
20
```yaml
21
-
- pipe: configcat/scan-repository-pipe:1.8.0
21
+
- pipe: configcat/scan-repository-pipe:1.8.1
22
22
variables:
23
23
CONFIG_ID: 'PASTE-YOUR-CONFIG-ID-HERE'
24
24
# LINE_COUNT: '3' # optional
25
+
# TIMEOUT: '1800' # optional
25
26
# SUB_FOLDER: '/src' # optional
26
27
# EXCLUDE_KEYS: > # optional
27
28
# flag_key_to_exclude_1
@@ -42,6 +43,7 @@ Scan reports are uploaded for each branch of your repository that triggers the j
42
43
|`CONFIG_ID `| ID of the ConfigCat config to scan against. |☑||
43
44
|`CONFIGCAT_API_HOST`| ConfigCat Management API host. ||`api.configcat.com`|
44
45
|`LINE_COUNT`| Context line count before and after the reference line. (min: 1, max: 10) || 4 |
46
+
|`TIMEOUT`| Scan timeout in seconds (default: 1800, min: 60). If the scan does not finish within this time, it is aborted. No partial results are returned. The command exits with a timeout error. || 1800 |
45
47
|`SUB_FOLDER`| Sub-folder to scan, relative to the repository root folder. |||
46
48
|`EXCLUDE_KEYS`| List of feature flag keys that must be excluded from the scan report. |||
47
49
|`ALIAS_PATTERNS`| Comma delimited list of custom regex patterns used to search for additional aliases. |||
@@ -56,6 +57,7 @@ Scan reports are uploaded for each branch of your repository that triggers the w
56
57
|`file-url-template`| Template url used to generate VCS file links. Available template parameters: `commitHash`, `filePath`, `lineNumber`. Example: `https://github.com/my/repo/blob/{commitHash}/{filePath}#L{lineNumber}`|||
57
58
|`commit-url-template`| Template url used to generate VCS commit links. Available template parameters: `commitHash`. Example: `https://github.com/my/repo/commit/{commitHash}`|||
58
59
|`line-count`| Context line count before and after the reference line. (min: 1, max: 10) || 4 |
60
+
|`timeout`| Scan timeout in seconds (default: 1800, min: 60). If the scan does not finish within this time, it is aborted. No partial results are returned. The command exits with a timeout error. || 1800 |
59
61
|`sub-folder`| Sub-folder to scan, relative to the repository root folder. |||
60
62
|`exclude-keys`| List of feature flag keys that must be excluded from the scan report. |||
61
63
|`alias-patterns`| Comma delimited list of custom regex patterns used to search for additional aliases. |||
Copy file name to clipboardExpand all lines: website/versioned_docs/version-V1/advanced/code-references/github-action.mdx
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,6 +33,7 @@ You can find more information about GitHub Actions <a target="_blank" href="http
33
33
api-pass: ${{ secrets.CONFIGCAT_API_PASS }}
34
34
config-id: PASTE-YOUR-CONFIG-ID-HERE
35
35
# line-count: 5 # optional
36
+
# timeout: 1800 # optional
36
37
# sub-folder: src # optional
37
38
# exclude-keys: > # optional
38
39
# flag_key_to_exclude_1
@@ -56,6 +57,7 @@ Scan reports are uploaded for each branch of your repository that triggers the w
56
57
|`api-pass`| <atarget="_blank"href="https://app.configcat.com/my-account/public-api-credentials">ConfigCat Management API basic authentication password</a>. |☑||
57
58
|`api-host`| ConfigCat Management API host. ||`api.configcat.com`|
58
59
|`line-count`| Context line count before and after the reference line. (min: 1, max: 10) || 4 |
60
+
|`timeout`| Scan timeout in seconds (default: 1800, min: 60). If the scan does not finish within this time, it is aborted. No partial results are returned. The command exits with a timeout error. || 1800 |
59
61
|`sub-folder`| Sub-folder to scan, relative to the repository root folder. |||
60
62
|`exclude-keys`| List of feature flag keys that must be excluded from the scan report. |||
61
63
|`alias-patterns`| Comma delimited list of custom regex patterns used to search for additional aliases. |||
0 commit comments