Skip to Content
GitHub ActionConfiguration

Configuration

Inputs

InputRequiredDefaultDescription
api-keyYesYour LaunchGate API key
suiteYesEval suite slug
outputYesThe AI-generated output to evaluate
inputNo"{}"Input payload as JSON string
fail-on-abortNo"true"Whether to fail the workflow step on aborted runs
commentNo"true"Whether to post results as a PR comment
api-urlNo"https://api.launchgate.ai"LaunchGate API URL

Outputs

OutputDescription
statusRun status: cleared, aborted, error, or skipped
pass-ratePass rate as a decimal (e.g., 0.85)
run-idThe eval run ID

Examples

Basic usage

- name: Run eval uses: launchgate/eval-action@v1 with: api-key: ${{ secrets.LAUNCHGATE_API_KEY }} suite: "content-safety" output: ${{ steps.generate.outputs.text }}

With input context

- name: Run eval uses: launchgate/eval-action@v1 with: api-key: ${{ secrets.LAUNCHGATE_API_KEY }} suite: "rag-faithfulness" output: ${{ steps.generate.outputs.text }} input: | { "context": "${{ steps.retrieve.outputs.context }}", "query": "${{ steps.query.outputs.text }}" }

Non-blocking (warn only)

- name: Run eval (non-blocking) uses: launchgate/eval-action@v1 with: api-key: ${{ secrets.LAUNCHGATE_API_KEY }} suite: "my-suite" output: ${{ steps.generate.outputs.text }} fail-on-abort: "false"

Using outputs

- name: Run eval id: eval uses: launchgate/eval-action@v1 with: api-key: ${{ secrets.LAUNCHGATE_API_KEY }} suite: "my-suite" output: ${{ steps.generate.outputs.text }} - name: Check results run: | echo "Status: ${{ steps.eval.outputs.status }}" echo "Pass rate: ${{ steps.eval.outputs.pass-rate }}" echo "Run ID: ${{ steps.eval.outputs.run-id }}"

Without PR comments

- name: Run eval (silent) uses: launchgate/eval-action@v1 with: api-key: ${{ secrets.LAUNCHGATE_API_KEY }} suite: "my-suite" output: ${{ steps.generate.outputs.text }} comment: "false"

Secrets

Add your API key as a repository secret:

  1. Go to your repository Settings → Secrets and variables → Actions
  2. Click New repository secret
  3. Name: LAUNCHGATE_API_KEY
  4. Value: Your LaunchGate API key
Last updated on