Skip to content

Commit

Permalink
bitrise step example
Browse files Browse the repository at this point in the history
  • Loading branch information
@kp-cat
kp-cat committed Sep 5, 2024
1 parent 9c949eb commit d843763
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 3 deletions.
13 changes: 12 additions & 1 deletion website/docs/advanced/code-references/bitrise-step.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,15 @@ to automatically scan your source code for feature flag and setting usages and u
```yaml
- configcat-feature-flag-sync@0:
inputs:
- configcat_config_id: 'PASTE-YOUR-CONFIG-ID-HERE'
- configcat_config_id: 'PASTE-YOUR-CONFIG-ID-HERE' # required
# - line-count: 3 # optional
# - sub-folder: 'src' # optional
# - exclude-keys: > # optional
# flag_key_to_exclude_1
# flag_key_to_exclude_2
# - alias-patterns: "(\w+) = :CC_KEY,const (\w+) = feature_flags\.enabled\(:CC_KEY\)" # optional
# - usage-patterns: feature_flags\.enabled\(:CC_KEY\) # optional
# - verbose: true # optional
```

4. Commit & push your changes.
Expand All @@ -35,4 +43,7 @@ Scan reports are uploaded for each branch of your repository that triggers the j
| `configcat_api_host` | ConfigCat Management API host. | | `api.configcat.com` |
| `line_count` | Code snippet line count before and after the reference line. (min: 1, max: 10) | | 4 |
| `sub_folder` | Sub-folder to scan, relative to the repository root folder. | | |
| `exclude-keys` | List of feature flag keys that must be excluded from the scan report. | | |
| `alias-patterns` | Comma delimited list of custom regex patterns used to search for additional aliases. | | |
| `usage-patterns` | Comma delimited list of custom regex patterns that describe additional feature flag key usages. | | |
| `verbose` | Turns on detailed logging. | | false |
15 changes: 13 additions & 2 deletions website/versioned_docs/version-V1/advanced/code-references/bitrise-step.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,15 @@ to automatically scan your source code for feature flag and setting usages and u
```yaml
- configcat-feature-flag-sync@0:
inputs:
- configcat_config_id: 'PASTE-YOUR-CONFIG-ID-HERE'
- configcat_config_id: 'PASTE-YOUR-CONFIG-ID-HERE' # required
# - line-count: 3 # optional
# - sub-folder: 'src' # optional
# - exclude-keys: > # optional
# flag_key_to_exclude_1
# flag_key_to_exclude_2
# - alias-patterns: "(\w+) = :CC_KEY,const (\w+) = feature_flags\.enabled\(:CC_KEY\)" # optional
# - usage-patterns: feature_flags\.enabled\(:CC_KEY\) # optional
# - verbose: true # optional
```

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

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

0 comments on commit d843763

Please sign in to comment.