Sprkl Action

Further documentation and guidelines are maintained on our docs.

Usage

Setup Sprkl in your workflow

Add the following step to make Sprkl CLI available in your workflow:

      - name: Sprkl Setup
        uses: sprkl-dev/sprkl-action/setup@master
        with:
          token: ${{ secrets.SPRKL_GITHUB_ACTIONS_TOKEN }}

Since Sprkl analyzes your git history (Why?) during the workflow, so make sure to include it in your action by setting fetch-depth: 0 in actions/checkout:

      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
          
      - name: Sprkl Setup
        uses: sprkl-dev/sprkl-action/setup@master
        with:
          token: ${{ secrets.SPRKL_GITHUB_ACTIONS_TOKEN }}

Follow the example action in sprkl microservices example repository.

Access

In order to get an acces token, setup the Sprkl Reviewer (GitHub Application).