Review, lint & publish with GitHub Actions

The following steps introduce the GitHub action to your repository. This action sets up tessl so it can be used for any CI/CD use case, such as auto-publishing plugins, linting or running skill reviews on PRs, etc.

If you're migrating your skill into Tessl's registry, using the GitHub action will automatically link your plugin to the repository, and all skills we previously indexed in the repository will be hidden and redirected to the plugins. See Tessl's setup-tessl GitHub action for additional options and information.

1

Create your workflow

Create your workflow file in .github/workflows for your desired action. For example, here's how you'd set up an auto-publish action.

2

Create an API Key

Log into Tessl on web UI, then navigate to API keys. Create a new API key. Copy the value as it will only be shown once.

3

Add your API Key as a Repository Secret

In GitHub, navigate to your repo Settings, select Secrets and variables, under actions find New Repository Secret. Provide the name: TESSL_TOKEN and the value is the Tessl API key you procured in the earlier step.

4

Run your workflow

Kick off your workflow by running the relevant trigger, or manually triggering from the UI if you enabled that in your workflow definition.

Gating pull requests with Tessl Review

Once TESSL_TOKEN is set as a repository secret, you can gate a pull request on a skill's review score using tessl review run. This is the authenticated, asynchronous review path: it requires auth and a workspace, kicks off a review pipeline server-side, and polls until the review completes. With --json --threshold, the command exits non-zero when the score falls below the threshold, failing the check.

The job below reviews a skill and fails if its score is under 80%:

name: Skill review

on:
  pull_request:

jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: tesslio/setup-tessl@v2
        with:
          token: ${{ secrets.TESSL_TOKEN }}
      - name: Review skill
        run: tessl review run ./my-skill --workspace engteam --json --threshold 80

--workspace is required whenever --json is set, since CI runs non-interactively and cannot prompt for a workspace. Point the path at the skill file or skill directory you want to review.

For the full flag reference, see tessl review run. For more on running reviews and the companion commands, see Check a skill's quality using review.