README.md

echo-eval CI

This GitHub Actions workflow initializes, lints, and tests the echo-eval project.

Index

1. Triggers
2. Inputs
3. Steps
4. Outputs
5. See Also

Triggers

This GitHub action will run under the following circumstances:

1. When code is pushed.
2. When a pull request is opened.
3. On a workflow dispatch event, a manual CI run which can be triggered by the "Workflow Dispatch" button on the "Actions" tab of the GitHub repository, among other means.

Inputs

There are currently no user-defined inputs for this pipeline, aside from the source code itself.

Steps

This workflow performs the following steps on GitHub runners:

1. Attach Documentation
   1. Checkout this repo with no submodules.
   2. Attach an annotation to the GitHub Actions build summary page containing CI documentation.
2. Lint and Test echo-eval
   1. Checkout this repo.
   2. Install system dependencies using .github/workflows/deps.sh.
   3. Initialize the project using bpkg install --dev.
   4. Lint the project with shellcheck and bashate by running bpkg run lint.
   5. Test the project using bats by running bpkg run test.

Outputs

There are currently no outputs of this GitHub Actions workflow besides the exit status.

See Also

• echo-eval Documentation

For assistance with the CI system, please open an issue in this repo.

---

Legal notice
This document was created in collaboration with a large language model, machine learning algorithm, or weak artificial intelligence (AI). This notice is required in some countries.