CI Reform

[rrbutani]

what

We should: fix up CI and actually gate PRs on it.

This is blocked on:

• fixing tests (Test reform #169)
• fixing lints (Clippy clean #170)
• fixing docs (Docs! #172)
• formatting (Formatting, code style #173)

We want these things out of our CI setup:

• testing our MSRV as well as nightly rust every night
  • with caching (preferably not something as janky as our last solution)
  • see these notes for rustdoc
  • testing includes:
    • tests, doctests, examples, benchmarks (i.e. cargo t)
    • doc lints (cargo nightly docs)
    • lints (cargo lint)
    • format check (cargo fc) (todo: is there a way to wire this up to GHA like clippy?)
• testing on macOS, Linux, and Windows
  • using the nix flake for macOS/Linux, probably
  • on windows we'll need to install LC3Tools by hand? (until Switch to using lc3tools-sys for the lc3tools test infrastructure #115 happens)
  • populate the UTP cachix cache
• showing us lint errors on PRs
• building and deploying docs to gh pages (for pushes to main)
• showing up benchmark perf diffs on PRs
• release automation on tags (changelog checking + linking, gh releases, checking that versions are in sync, checking that the docs.rs link in the crate roots has the right version, pushing to crates.io)
• measuring code coverage for the project
• badges on the main readme as appropriate (license, build status, coverage, docs index page link badge) and on the crates (just docs + crates.io badges)
  • gonna do away with build badges per crate, was excessive

steps

• ...

where

branch: imp/ci-reform

open questions