Skip to content

Commit 4a381b4

Browse files
kp-catkp-cat
authored
Bitrise step update (#482)
* typo fix * bitrise step example
1 parent c5e5b60 commit 4a381b4

File tree

8 files changed

+37
-15
lines changed

8 files changed

+37
-15
lines changed

‎website/docs/advanced/code-references/bitbucket-pipe.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ You can find more information about Bitbucket Pipelines <a target="_blank" href=
2424
# LINE_COUNT: '3' # optional
2525
# SUB_FOLDER: '/src' # optional
2626
# EXCLUDE_KEYS: > # optional
27-
# flag_key_to_exclue_1
28-
# flag_key_to_exclue_2
27+
# flag_key_to_exclude_1
28+
# flag_key_to_exclude_2
2929
# ALIAS_PATTERNS: (\w+) = :CC_KEY,const (\w+) = feature_flags\.enabled\(:CC_KEY\) # optional
3030
# USAGE_PATTERNS: feature_flags\.enabled\(:CC_KEY\)
3131
# VERBOSE: 'true' # optional

‎website/docs/advanced/code-references/bitrise-step.mdx

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,15 @@ to automatically scan your source code for feature flag and setting usages and u
2020
```yaml
2121
- configcat-feature-flag-sync@0:
2222
inputs:
23-
- configcat_config_id: 'PASTE-YOUR-CONFIG-ID-HERE'
23+
- configcat_config_id: 'PASTE-YOUR-CONFIG-ID-HERE' # required
24+
# - line-count: 3 # optional
25+
# - sub-folder: 'src' # optional
26+
# - exclude-keys: > # optional
27+
# flag_key_to_exclude_1
28+
# flag_key_to_exclude_2
29+
# - alias-patterns: "(\w+) = :CC_KEY,const (\w+) = feature_flags\.enabled\(:CC_KEY\)" # optional
30+
# - usage-patterns: feature_flags\.enabled\(:CC_KEY\) # optional
31+
# - verbose: true # optional
2432
```
2533

2634
4. Commit & push your changes.
@@ -35,4 +43,7 @@ Scan reports are uploaded for each branch of your repository that triggers the j
3543
| `configcat_api_host` | ConfigCat Management API host. | | `api.configcat.com` |
3644
| `line_count` | Code snippet line count before and after the reference line. (min: 1, max: 10) | | 4 |
3745
| `sub_folder` | Sub-folder to scan, relative to the repository root folder. | | |
46+
| `exclude-keys` | List of feature flag keys that must be excluded from the scan report. | | |
47+
| `alias-patterns` | Comma delimited list of custom regex patterns used to search for additional aliases. | | |
48+
| `usage-patterns` | Comma delimited list of custom regex patterns that describe additional feature flag key usages. | | |
3849
| `verbose` | Turns on detailed logging. | | false |

‎website/docs/advanced/code-references/circleci-orb.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ You can find more information about CircleCI Orbs <a target="_blank" href="https
3333
# line-count: 3 # optional
3434
# sub-folder: 'src' # optional
3535
# exclude-keys: > # optional
36-
# flag_key_to_exclue_1
37-
# flag_key_to_exclue_2
36+
# flag_key_to_exclude_1
37+
# flag_key_to_exclude_2
3838
# alias-patterns: (\w+) = :CC_KEY,const (\w+) = feature_flags\.enabled\(:CC_KEY\) # optional
3939
# usage-patterns: feature_flags\.enabled\(:CC_KEY\) # optional
4040
# verbose: true # optional

‎website/docs/advanced/code-references/github-action.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ You can find more information about GitHub Actions <a target="_blank" href="http
3535
# line-count: 5 # optional
3636
# sub-folder: src # optional
3737
# exclude-keys: > # optional
38-
# flag_key_to_exclue_1
39-
# flag_key_to_exclue_2
38+
# flag_key_to_exclude_1
39+
# flag_key_to_exclude_2
4040
# alias-patterns: (\w+) = :CC_KEY,const (\w+) = feature_flags\.enabled\(:CC_KEY\) #optional
4141
# usage-patterns: feature_flags\.enabled\(:CC_KEY\) # optional, comma delimited flag key usage patterns
4242
# verbose: true # optional

‎website/versioned_docs/version-V1/advanced/code-references/bitbucket-pipe.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ You can find more information about Bitbucket Pipelines <a target="_blank" href=
2424
# LINE_COUNT: '3' # optional
2525
# SUB_FOLDER: '/src' # optional
2626
# EXCLUDE_KEYS: > # optional
27-
# flag_key_to_exclue_1
28-
# flag_key_to_exclue_2
27+
# flag_key_to_exclude_1
28+
# flag_key_to_exclude_2
2929
# ALIAS_PATTERNS: (\w+) = :CC_KEY,const (\w+) = feature_flags\.enabled\(:CC_KEY\) # optional
3030
# USAGE_PATTERNS: feature_flags\.enabled\(:CC_KEY\)
3131
# VERBOSE: 'true' # optional

‎website/versioned_docs/version-V1/advanced/code-references/bitrise-step.mdx

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,15 @@ to automatically scan your source code for feature flag and setting usages and u
2020
```yaml
2121
- configcat-feature-flag-sync@0:
2222
inputs:
23-
- configcat_config_id: 'PASTE-YOUR-CONFIG-ID-HERE'
23+
- configcat_config_id: 'PASTE-YOUR-CONFIG-ID-HERE' # required
24+
# - line-count: 3 # optional
25+
# - sub-folder: 'src' # optional
26+
# - exclude-keys: > # optional
27+
# flag_key_to_exclude_1
28+
# flag_key_to_exclude_2
29+
# - alias-patterns: "(\w+) = :CC_KEY,const (\w+) = feature_flags\.enabled\(:CC_KEY\)" # optional
30+
# - usage-patterns: feature_flags\.enabled\(:CC_KEY\) # optional
31+
# - verbose: true # optional
2432
```
2533

2634
4. Commit & push your changes.
@@ -31,8 +39,11 @@ Scan reports are uploaded for each branch of your repository that triggers the j
3139

3240
| Parameter | Description | Required | Default |
3341
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------- |
34-
| `configcat_config_id` | The [config ID](overview.mdx#config-id) tells the step which feature flags it should search for in your source code. | &#9745; | |
42+
| `configcat_config_id` | The [config ID](overview.mdx#config-id) tells the step which feature flags it should search for in your source code. | &#9745; | |
3543
| `configcat_api_host` | ConfigCat Management API host. | | `api.configcat.com` |
3644
| `line_count` | Code snippet line count before and after the reference line. (min: 1, max: 10) | | 4 |
3745
| `sub_folder` | Sub-folder to scan, relative to the repository root folder. | | |
46+
| `exclude-keys` | List of feature flag keys that must be excluded from the scan report. | | |
47+
| `alias-patterns` | Comma delimited list of custom regex patterns used to search for additional aliases. | | |
48+
| `usage-patterns` | Comma delimited list of custom regex patterns that describe additional feature flag key usages. | | |
3849
| `verbose` | Turns on detailed logging. | | false |

‎website/versioned_docs/version-V1/advanced/code-references/circleci-orb.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ You can find more information about CircleCI Orbs <a target="_blank" href="https
3333
# line-count: 3 # optional
3434
# sub-folder: 'src' # optional
3535
# exclude-keys: > # optional
36-
# flag_key_to_exclue_1
37-
# flag_key_to_exclue_2
36+
# flag_key_to_exclude_1
37+
# flag_key_to_exclude_2
3838
# alias-patterns: (\w+) = :CC_KEY,const (\w+) = feature_flags\.enabled\(:CC_KEY\) # optional
3939
# usage-patterns: feature_flags\.enabled\(:CC_KEY\) # optional
4040
# verbose: true # optional

‎website/versioned_docs/version-V1/advanced/code-references/github-action.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ You can find more information about GitHub Actions <a target="_blank" href="http
3535
# line-count: 5 # optional
3636
# sub-folder: src # optional
3737
# exclude-keys: > # optional
38-
# flag_key_to_exclue_1
39-
# flag_key_to_exclue_2
38+
# flag_key_to_exclude_1
39+
# flag_key_to_exclude_2
4040
# alias-patterns: (\w+) = :CC_KEY,const (\w+) = feature_flags\.enabled\(:CC_KEY\) #optional
4141
# usage-patterns: feature_flags\.enabled\(:CC_KEY\) # optional, comma delimited flag key usage patterns
4242
# verbose: true # optional

0 commit comments

Comments
 (0)