`ci.yaml` runs two jobs on GitHub-hosted runners, gated on the repository name so that forks do not run them. `cargo-deny` checks licenses, advisories and sources. `lint` runs `nix flake check`, which builds every check of the flake, and the repository's own macro rules from the justfile. The triggers are the ones komorebi for Mac uses: pull requests, pushes to master, feature and hotfix branches, version tags, a weekly schedule and a manual run. The Nix store is cached with cache-nix-action, which needs no account. komorebi follows the tip of nixpkgs-unstable, so `flake.lock` moves, and KWin with it. `update-flake-lock.yaml` opens a pull request each week with the title `chore(deps): flake.lock: Update`; the same jobs run on it, which is what says whether the new KWin still works. Dependabot keeps the actions and the crates up to date, and the pull request template carries over from komorebi for Mac. CONTRIBUTING.md describes what CI runs.
komorebi for KDE
A tiling window manager for KDE Plasma on Wayland, in the family of komorebi for Windows and komorebi for Mac. The daemon decides where each window goes, and KWin, the window manager of Plasma, does the moving and the drawing.
Running it locally
nix develop
cargo run --bin komorebi --locked -- --version
nix develop provides the Rust toolchain that rust-toolchain.toml
selects, a nightly rustfmt, and the tools just check and the flake's checks
use. With direnv, the .envrc does it on
cd. On Linux, nix run .#komorebi -- --version builds and runs the daemon
without a checkout of the toolchain.
Crates
Checks
just check runs the formatting check, clippy with warnings denied, the tests
and rustdoc with warnings denied, inside nix develop. nix flake check runs
the same checks as derivations, plus cargo deny, the TOML and Nix formatting,
and the tests under cargo nextest, on Linux and on an Apple silicon Mac. A Mac
runs the tests against the fake desktop, since KWin only exists on Linux.
nix fmt formats every file the checks look at.
Documentation
cargo doc --workspace --no-deps --open builds the API documentation.
CONTRIBUTING.md says how to work on the code.
License
komorebi for KDE is under the Komorebi License. Contributions
are accepted under the terms in CONTRIBUTING.md.