Github Actions

This Github Action allows you to use Orquesta rules in your workflows. With this action, you can configure your applications using the remote configurations from Orquesta, enable/disable features or jobs using feature flags, or customize your applications based on different parameters.

Demo

We use an api-rate-limit rule as example to showcase Github Actions with return type number.

Usage

To use this action, create a new workflow in your GitHub repository's .github/workflows directory (e.g. orquesta-action.yml). Then, copy and paste the following code:

on:
  push:
    branches: [main]

jobs:
  orquesta:
    runs-on: ubuntu-latest
    name: Evaluate your Orquesta rule
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0

      - uses: orquestadev/orquesta-action@v1
        id: api_rate_limit
        with:
          apiKey: ${{secrets.ORQUESTA_API_KEY}}
          ruleKey: api-rate-limit
          context: '{"environments": "production", "customer-tier": "freemium"}'

      - name: Use your rule result
        run: |
          echo "The result of the rule evaluation is ${{ steps.api_rate_limit.outputs.result }}"

You can find your Orquesta API Key in the settings for your Orquesta workspace. We recommend using GitHub Secrets to store your API Key securely.

Extra Examples

1. Using a rule of type boolean to disable a job

   on:
     push:
       branches: [main]
   
   jobs:
     orquesta:
       runs-on: ubuntu-latest
       steps:
         - uses: actions/checkout@v3
           with:
             fetch-depth: 0
   
         - uses: orquestadev/orquesta-action@v1
           id: code_freeze_enabled
           with:
             apiKey: ${{secrets.ORQUESTA_API_KEY}}
             ruleKey: code_freeze_enabled
             context: '{"environments": "production"}'
   
         - name: Backend deployment
           if: steps.code_freeze_enabled.outputs.result == 'false'
   
   

   
   

2. Using a Rule of type JSON to configure your GitHub artifacts upload
   
   

   on:
     push:
       branches: [main]
   
   jobs:
     orquesta:
       runs-on: ubuntu-latest
       steps:
         - uses: actions/checkout@v3
           with:
             fetch-depth: 0
   
         - uses: orquestadev/orquesta-action@v1
           id: artifacts_config
           with:
             apiKey: ${{secrets.ORQUESTA_API_KEY}}
             ruleKey: artifacts_config
             context: '{"accountId": "account007", "cloudProvider": "aws"}'
   
         - uses: actions/upload-artifact@v3
           with:
             name: ${{fromJSON(steps.artifacts_config.outputs.result)['name']}}
             path: ${{fromJSON(steps.artifacts_config.outputs.result)['path'