Skip to content

Add GH scan action repository input param #721

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
z4kn4fein wants to merge 1 commit into
base: master
Choose a base branch
from
+16 −12
Open

Add GH scan action repository input param #721

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions website/docs/advanced/code-references/github-action.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,16 @@ Create a new Actions workflow in your GitHub repository under the `.github/workf
api-user: ${{ secrets.CONFIGCAT_API_USER }}
api-pass: ${{ secrets.CONFIGCAT_API_PASS }}
config-id: PASTE-YOUR-CONFIG-ID-HERE
# line-count: 5 # optional
# timeout: 1800 # optional
# sub-folder: src # optional
# exclude-keys: > # optional
# repository: owner/repository # optional, defaults to the current GitHub repository
# line-count: 5 # optional
# timeout: 1800 # 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
# alias-patterns: (\w+) = :CC_KEY,const (\w+) = feature_flags\.enabled\(:CC_KEY\) #optional
# usage-patterns: feature_flags\.enabled\(:CC_KEY\) # optional, comma delimited flag key usage patterns
# verbose: true # optional
# verbose: true # optional
```
</Step>
<Step>
Expand All @@ -64,6 +65,7 @@ Scan reports are uploaded for each branch of your repository that triggers the w
| `api-user` | <a target="_blank" href="https://app.configcat.com/my-account/public-api-credentials">ConfigCat Management API basic authentication username</a>. | &#9745; | |
| `api-pass` | <a target="_blank" href="https://app.configcat.com/my-account/public-api-credentials">ConfigCat Management API basic authentication password</a>. | &#9745; | |
| `api-host` | ConfigCat Management API host. | | `api.configcat.com` |
| `repository` | Name of the repository. | | Current GitHub repository (owner/repository) |
| `line-count` | Context line count before and after the reference line. (min: 1, max: 10) | | 4 |
| `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 |
| `sub-folder` | Sub-folder to scan, relative to the repository root folder. | | |
Expand Down
14 changes: 8 additions & 6 deletions website/versioned_docs/version-V1/advanced/code-references/github-action.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,16 @@ You can find more information about GitHub Actions <a target="_blank" href="http
api-user: ${{ secrets.CONFIGCAT_API_USER }}
api-pass: ${{ secrets.CONFIGCAT_API_PASS }}
config-id: PASTE-YOUR-CONFIG-ID-HERE
# line-count: 5 # optional
# timeout: 1800 # optional
# sub-folder: src # optional
# exclude-keys: > # optional
# repository: owner/repository # optional, defaults to the current GitHub repository
# line-count: 5 # optional
# timeout: 1800 # 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
# alias-patterns: (\w+) = :CC_KEY,const (\w+) = feature_flags\.enabled\(:CC_KEY\) #optional
# usage-patterns: feature_flags\.enabled\(:CC_KEY\) # optional, comma delimited flag key usage patterns
# verbose: true # optional
# verbose: true # optional
```

4. Commit & push your action.
Expand All @@ -56,6 +57,7 @@ Scan reports are uploaded for each branch of your repository that triggers the w
| `api-user` | <a target="_blank" href="https://app.configcat.com/my-account/public-api-credentials">ConfigCat Management API basic authentication username</a>. | &#9745; | |
| `api-pass` | <a target="_blank" href="https://app.configcat.com/my-account/public-api-credentials">ConfigCat Management API basic authentication password</a>. | &#9745; | |
| `api-host` | ConfigCat Management API host. | | `api.configcat.com` |
| `repository` | Name of the repository. | | Current GitHub repository (owner/repository) |
| `line-count` | Context line count before and after the reference line. (min: 1, max: 10) | | 4 |
| `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 |
| `sub-folder` | Sub-folder to scan, relative to the repository root folder. | | |
Expand Down
Loading