Rails engines and Rails gems

Use lesli-ci-engine.yaml for both traditional Lesli engines and gems that implement Rails::Engine. They share the same test and build contract; the module-directory input tells integration hosts where to install the caller.

Requirements

The repository must provide:

bundle exec rake test
bundle exec rake build

The test task must generate coverage/coverage.xml when COVERAGE=true, and the build task must generate a package under pkg/*.gem.

When security is enabled, Brakeman must be present in the bundle and security-path must point to a Rails application Brakeman can scan. An engine with a dummy application commonly uses test/dummy.

Engine caller

An engine installed under engines/ can use:

name: "Lesli CI"

on:
  push:
    branches: [master]
  pull_request:
  workflow_dispatch:

jobs:
  ci:
    uses: LesliTech/LesliActions/.github/workflows/lesli-ci-engine.yaml@master
    with:
      ruby-version: "3.3.5"
      module-directory: "engines"
      security-path: "test/dummy"
      run-security: true
      run-integration: true
      run-integration-new: false
    secrets:
      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

Use security-path: "." instead when the repository root itself is a complete Rails application.

Rails gem caller

A Rails gem installed under gems/ uses the same main workflow:

name: "Lesli CI"

on:
  push:
    branches: [master]
  pull_request:
  workflow_dispatch:

jobs:
  ci:
    uses: LesliTech/LesliActions/.github/workflows/lesli-ci-engine.yaml@master
    with:
      ruby-version: "3.3.5"
      module-directory: "gems"
      run-security: false
      run-integration: true
      run-integration-new: false
    secrets:
      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

Disabling security is appropriate when the gem does not contain a Rails application that Brakeman can inspect. It does not weaken or skip the gem's test, build, or requested integration stages.

Inputs

module-directory accepts only engines or gems. Integration stops with a clear error for any other value.

Execution order

Security
└── Tests, coverage, and gem build
    └── LesliBuilder integration
        └── Generated Rails application integration

The generated-host stage depends on the test job and, when enabled, the LesliBuilder integration. It can still run when run-integration is deliberately disabled, but it never runs after a failure or cancellation.

Recommended adoption

Start with unit tests and the real host integration:

run-security: true
run-integration: true
run-integration-new: false

Enable run-integration-new once the module declares every dependency it needs and can install into a clean application. This stage is intentionally stricter than testing inside LesliBuilder, where other modules may provide dependencies implicitly.