Home

Welcome to the Loom CI/CD Wiki

Below you will find expected outputs and how-to guides for the following workflow scripts

• compile-examples

• clang-format

...

compile-examples

How to Run

Basic Command

py compile_examples.py --dependency-report 'file_name.md'

Additional Commands

py compile_examples.py --help'

Expected Results

Initial check and successful compilations.

Dependency Warning

Failure report

Generating a dependency report

clang-format

How to Run

Basic Command

To fix py run-clang-format.py -i . OR --fix

To report py run-clang-format.py -r .

Detailed Command

py run-clang-format.py --help

Expected Results

Initial check and successful compilations.

Running Workflows Locally

Running a workflow file locally can be easy but you'll need a few things.

1. Install Docker Destop

https://docs.docker.com/desktop/setup/install/windows-install/

2. Checkout workflow from https://github.com/OPEnSLab-OSU/ci-loom

https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens

3. Install act

https://nektosact.com/installation/index.html

Then,

Ensure you have Docker Desktop running and test act using act --list in your projects directory.

You should see a list of available workflows

If you don't see a list ensure you have checked out the workflows and are in the right directory.

Next, run a workflow using act workflow_dispatch -j 'job'

e.g. act workflow dispatch -j clang_format

Note: The compile-examples workflow checks out the current board-package when testing locally. It is best used as a script or with GitHub Actions.