CI integration - Lark Documentation

Configuring CI

You can use the Lark CLI to run your testing workflows as part of your deployment. The --wait flag blocks until every workflow finishes and exits with a non-zero code on failure, so your pipeline fails if a test fails. Set the GETLARK_API_KEY environment variable in your CI provider’s secrets settings before adding the steps below.

GitHub Actions

- name: Run Lark Tests
  run: npx -y @getlark/cli workflows invoke --all --wait
  env:
    GETLARK_API_KEY: ${{ secrets.GETLARK_API_KEY }}

CircleCI

lark_tests:
  docker:
    - image: cimg/node:lts
  resource_class: small
  steps:
    - run:
        name: Run Lark Tests
        command: npx -y @getlark/cli workflows invoke --all --wait

GitLab CI

lark_tests:
  image: node:lts
  script:
    - npx -y @getlark/cli workflows invoke --all --wait

Each provider stores secrets in a different place. Add GETLARK_API_KEY under:

GitHub Actions: Settings → Secrets and variables → Actions
CircleCI: Project Settings → Environment Variables
GitLab CI: Settings → CI/CD → Variables