Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions website/docs/integrations/github-cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ description: This is a step-by-step guide on how to use the ConfigCat CLI in you

This section describes how to install and use the ConfigCat CLI in GitHub Action workflows.

### Prerequisites
## Prerequisites

- To let the CLI access the ConfigCat Public Management API, you have to create a new <a target="_blank" href="https://app.configcat.com/my-account/public-api-credentials">API credential</a>.
Store the credential in your repository's <a target="_blank" href="https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository">GitHub Secrets</a> with the following names: `CONFIGCAT_API_USER`, `CONFIGCAT_API_PASS`.

<img src="/docs/assets/cli/scan/github_secrets.png" alt="Github Action secrets" decoding="async" loading="lazy" />

### Example
## Example
The following example shows how you can install the ConfigCat CLI with ConfigCat's <a href="https://github.com/configcat/cli-actions" target="_blank">CLI Github Actions</a> in your workflow.

```yaml
Expand Down
12 changes: 6 additions & 6 deletions website/docs/integrations/github-eval.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ description: This is a step-by-step guide on how to evaluate ConfigCat feature f
ConfigCat's <a href="https://github.com/configcat/cli-actions" target="_blank">CLI GitHub Actions</a> has the ability to evaluate feature flags in GitHub Action workflows.
This feature lets you use your feature flag values or create conditional steps in your workflow.

### Prerequisites
## Prerequisites

- An SDK key for the ConfigCat config/environment pair that contains the feature flags you want to evaluate.

### Example
## Example

The following example shows how you can evaluate ConfigCat feature flags and use the evaluated results in subsequent steps.

Expand All @@ -28,8 +28,8 @@ jobs:
with:
sdk-key: ${{ secrets.CONFIGCAT_SDK_KEY }}
flag-keys: |
flag1
flag2
flag1:false
flag2:false
user-attributes: |
id:1234

Expand All @@ -44,12 +44,12 @@ jobs:

The results of the flag evaluations are stored in the step outputs named with each flag's key.

### Available Options
## Available Options

| Parameter | Description | Required | Default |
| ---------------- | ---------------------------------------------------------------------------------------------------------- | ---------- | ------------------- |
| `sdk-key` | SDK key identifying the config to download, also loaded from the `CONFIGCAT_SDK_KEY` environment variable | | |
| `flag-keys` | List of feature flag keys to evaluate. Multiple values must be in separate lines. | &#9745; | |
| `flag-keys` | List of feature flag keys and their default values to evaluate. Multiple values must be in separate lines in the following format: `<key>:<default_value>`. Not setting a default value will set the flag's default value to `''`. | &#9745; | |
| `user-attributes` | List of user attributes used for evaluation. Multiple values must be in separate lines in the following format: `<key>:<value>`. Dedicated User Object attributes are mapped like the following: Identifier => id, Email => email, Country => country. | | |
| `base-url` | The CDN base url from where the CLI will download the config JSON. | | ConfigCat CDN servers. |
| `data-governance` | Describes the location of your feature flag and setting data within the ConfigCat CDN. Possible values: `eu`, `global`. | | `global` |
Expand Down
2 changes: 0 additions & 2 deletions website/docs/sdk-reference/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: List of all supported technologies like .NET, Java, JavaScript, Nod

The purpose of the SDKs is to download and cache feature flag values and to evaluate Targeting Rules. All SDKs provide a simple interface for accessing your feature flags from your application.

Check out our language specific <a href="https://app.configcat.com/sdkkey" target="_blank">Getting Started Guide</a> on how to connect your applications.

<div className="sdk-cards">
<div className="sdk-card">
<a className="title-link" href="/docs/sdk-reference/dotnet">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ description: This is a step-by-step guide on how to use the ConfigCat CLI in you

This section describes how to install and use the ConfigCat CLI in GitHub Action workflows.

### Prerequisites
## Prerequisites

- To let the CLI access the ConfigCat Public Management API, you have to create a new <a target="_blank" href="https://app.configcat.com/my-account/public-api-credentials">API credential</a>.
Store the credential in your repository's <a target="_blank" href="https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository">GitHub Secrets</a> with the following names: `CONFIGCAT_API_USER`, `CONFIGCAT_API_PASS`.

<img src="/docs/assets/cli/scan/github_secrets.png" alt="Github Action secrets" decoding="async" loading="lazy" />

### Example
## Example
The following example shows how you can install the ConfigCat CLI with ConfigCat's <a href="https://github.com/configcat/cli-actions" target="_blank">CLI Github Actions</a> in your workflow.

```yaml
Expand Down
12 changes: 6 additions & 6 deletions website/versioned_docs/version-V1/integrations/github-eval.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ description: This is a step-by-step guide on how to evaluate ConfigCat feature f
ConfigCat's <a href="https://github.com/configcat/cli-actions" target="_blank">CLI GitHub Actions</a> has the ability to evaluate feature flags in GitHub Action workflows.
This feature lets you use your feature flag values or create conditional steps in your workflow.

### Prerequisites
## Prerequisites

- An SDK key for the ConfigCat config/environment pair that contains the feature flags you want to evaluate.

### Example
## Example

The following example shows how you can evaluate ConfigCat feature flags and use the evaluated results in subsequent steps.

Expand All @@ -28,8 +28,8 @@ jobs:
with:
sdk-key: ${{ secrets.CONFIGCAT_SDK_KEY }}
flag-keys: |
flag1
flag2
flag1:false
flag2:false
user-attributes: |
id:1234

Expand All @@ -44,12 +44,12 @@ jobs:

The results of the flag evaluations are stored in the step outputs named with each flag's key.

### Available Options
## Available Options

| Parameter | Description | Required | Default |
| ---------------- | ---------------------------------------------------------------------------------------------------------- | ---------- | ------------------- |
| `sdk-key` | SDK key identifying the config to download, also loaded from the `CONFIGCAT_SDK_KEY` environment variable | | |
| `flag-keys` | List of feature flag keys to evaluate. Multiple values must be in separate lines. | &#9745; | |
| `flag-keys` | List of feature flag keys and their default values to evaluate. Multiple values must be in separate lines in the following format: `<key>:<default_value>`. Not setting a default value will set the flag's default value to `''`. | &#9745; | |
| `user-attributes` | List of user attributes used for evaluation. Multiple values must be in separate lines in the following format: `<key>:<value>`. Dedicated User Object attributes are mapped like the following: Identifier => id, Email => email, Country => country. | | |
| `base-url` | The CDN base url from where the CLI will download the config JSON. | | ConfigCat CDN servers. |
| `data-governance` | Describes the location of your feature flag and setting data within the ConfigCat CDN. Possible values: `eu`, `global`. | | `global` |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: List of all supported technologies like .NET, Java, JavaScript, Nod

The purpose of the SDKs is to download and cache feature flag values and to evaluate Targeting Rules. All SDKs provide a simple interface for accessing your feature flags from your application.

Check out our language specific <a href="https://app.configcat.com/sdkkey" target="_blank">Getting Started Guide</a> on how to connect your applications.

<div className="sdk-cards">
<div className="sdk-card">
<a className="title-link" href="/docs/V1/sdk-reference/dotnet">
Expand Down
Loading