Skip to content

Commit

Permalink
README: add descriptions of common workflows
Browse files Browse the repository at this point in the history
Signed-off-by: Gerwin Klein <[email protected]>
  • Loading branch information
lsf37 committed Feb 10, 2024
1 parent 5fb801b commit 5f52f8d
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

[![CI](https://github.com/seL4/ci-actions/actions/workflows/push.yml/badge.svg)](https://github.com/seL4/ci-actions/actions/workflows/push.yml)

# CI actions for seL4 repositories
# CI actions and Workflows for seL4 repositories

This repository collects definitions for continuous integration (CI)
tasks/actions for the repositories of the seL4 foundation. While some of these
Expand All @@ -15,11 +15,22 @@ The idea is to concentrate most of the GitHub workflow definitions here in a
single repository to avoid duplication, share code between actions, and to make
it easier to replicate a similar CI setup on other platforms.

Currently, everything is fairly GitHub-specific, but that could change over
time.

Shared JavaScript is in [`js/`](js/), and shared shell scripts are in [`scripts/`](scripts/)

This repository also defines a number of GitHub action workflows that can be
called from other repositories. These are all files in `.github/workflows` that
define an `on: workflow_call` trigger. In particular:

- [pr.yml](.github/workflows/pr.yml) for standard pull requests checks (gitlint,
whitespace, shell checks, style)
- [push.yml](.github/workflows/push.yml) for standard push checks (links, licenses)
- [sel4test-sim.yml](.github/workflows/sel4test-sim.yml) for running the
seL4 simulation tests
- [sel4test-hw.yml](.github/workflows/sel4test-hw.yml) for running the
seL4 hardware tests
- [sel4bench-hw.yml](.github/workflows/sel4test-hw.yml) for running the
seL4 hardware benchmarks

## Availabe actions

The following GitHub actions are available:
Expand Down

0 comments on commit 5f52f8d

Please sign in to comment.