Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Checks and workflows

What scripts/ci.sh checks on your machine, and what each GitHub workflow checks. Run the checks says how to run them.

The stages of scripts/ci.sh

The script runs these stages in order and stops at the first failure. A stage runs only when a file that it checks changed since the last green run. The last green run is the tree in target/ci-green-tree; without it, the script compares with the branch’s merge base with main. --all runs every stage.

StageWhat it checksWhen it runs
workflowsactionlint (with shellcheck) and zizmor, pedantic, over .github/.github/ changed
issue formsEvery field of every issue form is valid (Ruby’s YAML)An issue form changed
spellingtypos, over the changed filesAlways
release scriptsThe release notes test, every changelog section and its compare link, and the version parser’s testCHANGELOG.md or a release script changed
bookmdbook build docsA Markdown file, the style rules or the tutorial’s driver changed
proseVale, over every Markdown file, with warnings shownAs “book”
linkslychee, over every Markdown file and over the built bookAs “book”
fmtcargo fmt --all --checkA Rust crate changed
clippyClippy, with warnings as errors, over the crates that the change reachesAs “fmt”
testsThe tests of those cratesAs “fmt”
without midirClippy and the tests of oscyl-midi and oscyl-app without their feature midir, as the mobile apps build themThe change reaches oscyl-midi or oscyl-app
conformanceEach driver’s tests/conformance.rs. A driver crate without one failsThe change reaches that driver
docscargo doc, with warnings as errorsAs “fmt”
ffi bindingsscripts/mobile-rust.sh: the Kotlin bindings, and the Android libraries when cargo-ndk and an NDK existThe change reaches oscyl-ffi
iosClippy of oscyl-ffi for both iOS targets, when they are installedAs “ffi bindings”
(Xcode files)scripts/mobile-assets.sh --checkThe mobile app, the design tokens, the icons, the fonts or a licence text changed
licencesscripts/licences.sh --check: the About pages list the crates of Cargo.lockCargo.lock or the licence script changed
mobile appThe common Kotlin, :shared:check, the behaviour tests, the screenshot goldens, the debug build and the iOS platform klibsThe mobile app or the design tokens changed, or the change reaches oscyl-ffi. Needs ANDROID_HOME
accessibilityThe accessibility checks, on a running emulator or on one that Gradle managesA UI source of the mobile app changed. Needs /dev/kvm
cargo denyLicences, advisories, bans and sources of the dependenciesA manifest, Cargo.lock or deny.toml changed

The screenshot goldens run only when a file under apps/mobile, design or po changed. For a change to the Rust core alone, the mobile stage runs the behaviour tests without them.

The GitHub workflows

WorkflowJobs and what they checkWhen it runs
CI (ci.yml)rust: fmt, clippy and the tests of the workspace, and the build without midir. desktop: the tests and the command line on macOS and Windows. conformance: each driver’s conformance test. msrv: the build with Rust 1.92. deny: cargo-deny. docs: rustdoc with warnings as errors. book: the book, its prose and its links. licences, typos. flatpak-sources and gtk: the desktop app, built and tested in the GNOME runtime.Every push to main and every pull request
Android (android.yml)android: :shared:check, the behaviour tests, the screenshot goldens and the debug build. accessibility: the accessibility checks on an emulatorA change to the mobile app, the crates, the manifests or the design
iOS (ios.yml)The iOS tests, then the iOS app: built on macOS and started in a simulator, with a screenshotA change to the mobile app, the crates, the manifests or the design tokens
Desktop apps (desktop-apps.yml)The desktop app built and bundled for Windows and macOS, as a release does, then opened once with a simulated synth for a screenshotA change to the desktop app, the crates, the design, the translations or the bundle scripts
Fuzz (fuzz.yml)A short run of every fuzz targetA change to the crates or to fuzz/, and once a week
CodeQL (codeql.yml)Code scanningEvery push to main, every pull request, and once a week
Dependency review (dependency-review.yml)The dependencies that a pull request addsEvery pull request
Changelog (changelog.yml)A pull request that changes what users get also changes CHANGELOG.md, or has the label no-changelog. Docs, workflows, tests and Markdown are exempt.Every pull request
Lint workflows (lint-workflows.yml)actionlint and zizmorA change to .github/
Scorecard (scorecard.yml)The OpenSSF ScorecardEvery push to main, and once a week
Site (pages.yml)Publishes the website, the book and the API reference to GitHub PagesA change to the site, the book or the crates of the API reference
Release (release.yml)Builds, checks and attests every artifact; opens a draft release. See Release artifacts.A pushed tag vX.Y.Z, or by hand