EXAMPLES/ci-integration

CI Integration

Demonstrates integrating functional-examples into a CI pipeline using GitHub Actions. The workflow file is annotated with region tags for documentation extraction.

meta-yml7 FILEScigithub-actionsadvanced

CI Integration

Demonstrates integrating functional-examples testing into a GitHub Actions CI pipeline.

What This Shows

A GitHub Actions workflow for scanning and testing examples
Region-tagged workflow steps for documentation extraction
The same scan and test commands used locally and in CI

Running

bash

1# Scan for examples (same command used in CI)
2bash demo.sh

How It Works

The .github/workflows/examples.yml file defines a real GitHub Actions workflow that installs dependencies, scans for examples, and runs tests. Region tags (#_region) in the workflow file allow documentation to extract specific steps for inclusion in guides.

Push to GitHub to execute the workflow, or inspect the YAML directly to understand the CI setup.

All Example Files

FILE EXPLORER

README.md

1# CI Integration
2
3Demonstrates integrating functional-examples testing into a GitHub Actions CI pipeline.
4
5## What This Shows
6
7- A GitHub Actions workflow for scanning and testing examples
8- Region-tagged workflow steps for documentation extraction
9- The same `scan` and `test` commands used locally and in CI
10
11## Running
12
13```bash
14# Scan for examples (same command used in CI)
15bash demo.sh
16```
17
18## How It Works
19
20The `.github/workflows/examples.yml` file defines a real GitHub Actions workflow
21that installs dependencies, scans for examples, and runs tests. Region tags
22(`#_region`) in the workflow file allow documentation to extract specific steps
23for inclusion in guides.
24
25Push to GitHub to execute the workflow, or inspect the YAML directly to
26understand the CI setup.
27