This github action let you control your workflows and steps using the Split Software Feature Flags SDK. Only a Split Software free account is needed to use this Github Action to control your CI/CD pipelines!
Required your Split account API key
Required the account/user key
Required the splits (feature flags) to be evaluated. Should be a multiline string due to Github actions inputs limitations For instance:
with:
splits: |
feature_flag_a
feature_flag_bBecause features start their life on one developer's machine. A developer should be able to put code behind feature_flags on their development machine without the SDK requiring network connectivity. To achieve this, the Split SDK can be started in localhost mode (aka off-the-grid mode). In this mode, the SDK neither polls nor updates Split servers. Instead, it uses an in-memory data structure to determine what treatments to show to the logged in customer for each of the features.
To use the SDK in localhost mode, replace the API Key with "localhost", as shown in the example below:
with:
api-key: 'localhost'In this mode, the SDK loads a mapping of split name to treatment from a file at .github/splitio/.split. For a given feature_flag, the treatment specified in the file is returned for every customer.
Important: in order to get access to read the .split file from your repo, you must to run the checkout action before the Split evaluation.
- name: Checkout code
uses: actions/checkout@v2
- name: Evaluate action step
id: evaluator
uses: splitio/[email protected]
with:
api-key: 'localhost'
key: ${{ secrets.SPLIT_EVAL_KEY }}
splits: |
feature_flag_a
feature_flag_bHere is a sample .split file. The format of this file is two columns separated by a whitespace. The left column is the feature_flag name, and the right column is the treatment name.
# this is a comment
reporting_v2 on # sdk.getTreatment(*, reporting_v2) will return 'on'
double_writes_to_cassandra off
new-navigation v3
This is a JSON string representation with all evaluated results, for instance: {"feature_flag_a":"on","feature_flag_b":"off"}
After runing the action you will have available in the future steps environment blocks an env var named with the value of the input parameter feature_flags and the treatment result as its value. For instance, given the input:
on: [push]
jobs:
split_evaluator_test:
runs-on: ubuntu-latest
name: A job to test the Split evaluator github action
steps:
- name: Evaluate action step
id: evaluator
uses: splitio/[email protected]
with:
api-key: ${{ secrets.SPLIT_API_KEY }}
key: ${{ secrets.SPLIT_EVAL_KEY }}
splits: |
feature_flag_a
feature_flag_bThe next env vars env.feature_flag_a and env.feature_flag_b will be available on future steps like:
Running the step when the evaluation returned on
- name: Run only when treatment ON
if: ${{ env.feature_flag_a == 'on' }}
run: echo "Do something great here"Running the step when the evaluation returned off
- name: Run only when treatment OFF
if: ${{ env.feature_flag_b == 'off' }}
run: echo "Run something when feature_flag is Off"Also if there was some error on evaluation the Split SDK will return the control treatment
- name: Run only when treatment control
if: ${{ env.feature_flag_b == 'control' }}
run: echo "Run something when feature_flag evaluation was wrong"Sometimes it is useful having access to the evaluation results from a diferent job. To achieve this the job must to set up its output and the Github actions jobs dependency key-word needs is required in order to reference the output's evaluation job. The next is an example of this.
on: [push]
jobs:
split_evaluator:
runs-on: ubuntu-latest
name: A job to run the Split evaluator github action
steps:
- name: Evaluate action step
id: evaluator
uses: splitio/[email protected]
with:
api-key: ${{ secrets.SPLIT_API_KEY }}
key: ${{ secrets.SPLIT_EVAL_KEY }}
splits: |
enable_paywall
api_verbose
# The job outputs must be sets in order to share the evaluation results
outputs:
treatments: ${{ steps.evaluator.outputs.result }}
another_job:
# Job dependency. Means that before this one, the split_evaluator job
# will be executed and set up the evaluated output
needs: split_evaluator
runs-on: ubuntu-latest
steps:
- name: Run when paywall is enabled
if: ${{ fromJson(needs.split_evaluator.outputs.treatments).enable_paywall == 'on' }}
run: echo 'Paywall has been enabled'Note that to access the exported results the function fromJson is required in order to access the output values as an object.
fromJson(needs.split_evaluator.outputs.treatments).enable_paywall
Having the job dependency and fetching the output a Github action's job can be enabled or not which gave us the capability to control workflows.
on: [push]
jobs:
split_evaluator:
runs-on: ubuntu-latest
name: A job to run the Split evaluator github action
steps:
- name: Evaluate action step
id: evaluator
uses: splitio/[email protected]
with:
api-key: ${{ secrets.SPLIT_API_KEY }}
key: ${{ secrets.SPLIT_EVAL_KEY }}
splits: |
canary_deploy
integration_tests_v2
# The job outputs must be sets in order to share the evaluation results
outputs:
treatments: ${{ steps.evaluator.outputs.result }}
testing:
needs: split_evaluator
runs-on: ubuntu-latest
steps:
- name: Unit tests
run: echo 'running unit tests...'
- name: Integration tests
run: echo 'running integration tests...'
- name: Integration tests v2
if: ${{ fromJson(needs.split_evaluator.outputs.treatments).integration_tests_v2 == 'on' }}
run: echo 'running integration tests v2...'
deploy_canary:
needs: [split_evaluator, testing]
if: ${{ fromJson(needs.split_evaluator.outputs.treatments).canary_deploy == 'on' }}
runs-on: ubuntu-latest
steps:
- name: Deploy to CANARY env
run: echo 'deploying to CANARY...'
deploy_prod:
needs: [split_evaluator, testing]
runs-on: ubuntu-latest
steps:
- name: Deploy to PROD env
run: echo 'deploying to PROD...'