This GitHub Action is a utility that discovers ConfigCat feature flag and setting usages in your source code and uploads the found code references to ConfigCat.

For more information about repository scanning, see our documentation.

1. Create a new ConfigCat Management API credential and store its values in GitHub Secrets with the following names: CONFIGCAT_API_USER, CONFIGCAT_API_PASS.

   

2. Get the ID of your ConfigCat Config that you want to associate with your repository. The scanner will use this ID to determine which feature flags & settings to search for in your source code.

3. Create a new Actions workflow in your GitHub repository under the .github/workflows folder, and put the following snippet into it. Don't forget to replace the PASTE-YOUR-CONFIG-ID-HERE value with your actual Config ID.

   on: [push]
   name: Code references
   jobs:
     scan-repo:
       runs-on: ubuntu-latest
       name: Scan repository for code references
       steps:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Scan & upload
         uses: configcat/scan-repository@v1
         with:
           api-user: ${{ secrets.CONFIGCAT_API_USER }}
           api-pass: ${{ secrets.CONFIGCAT_API_PASS }}
           config-id: PASTE-YOUR-CONFIG-ID-HERE

4. Commit & push your action.

The above example configures a workflow that executes the scan and code references upload on every git push event. Scan reports are uploaded for each branch of your repository that triggers the workflow.