Execute Scenarios From GitHub Action

This guide will walk you through integrating lueur into your GitHub pipeline.

What You'll Achieve

You will learn how to run a lueur scenario as part of your GitHub workflow and use the result to fail a GitHub job.

Start your applicatiopn first

The guides below do not show how to run the target service from within your workflow. For instance, you could run a step like this first:

  - name: Run application under test in the background
    shell: bash
    run: RUNNER_TRACKING_ID="" && (nohup ./my-app &)

Run lueur's scenario - Step-by-Step

The basic approach to run lueur scenarios in your GitHub workflows is to use the dedicated action.

Run lueur's scenario

.github/workflows/reliability.yaml

name: Run lueur scenarios

on:
  workflow_dispatch:

jobs:
  run-reliability-scenarios:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: rebound-how/actions/lueur@main  # (1)!
        with:
          scenario: scenario.yaml  # (2)!

Add the lueur action
Path to a scenario file or a directory containing scenario files

Create an issue when at least one test failed - Step-by-Step

Run lueur's scenario

.github/workflows/reliability.yaml

name: Run lueur scenarios

on:
  workflow_dispatch:

jobs:
  run-reliability-scenarios:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: rebound-how/actions/lueur@main  # (1)!
        with:
          scenario: scenario.yaml  # (2)!
          report: report.md  # (3)!
          create-issue-on-failure: "true"  # (4)!
          github-token: ${{ secrets.GITHUB_TOKEN }}  # (5)!

Add the lueur action
Path to a scenario file or a directory containing scenario files
Export the report as a markdown document as it will be used as the body of the issue
Tell the action to create the issue if at least one test failed
Provide the github token so the operation is authenticaed appropriately. Make sure the token has write permissions