From 18fd74a2c3dbbc8774d9520303c5b8d0ec43d641 Mon Sep 17 00:00:00 2001 From: Erin van der Veen Date: Thu, 4 Apr 2024 10:51:37 +0200 Subject: [PATCH] chore: mark generate-coverage as broken, and remove reference to it in README --- CONTRIBUTING.md | 5 +---- bin/default.nix | 24 +++++++++++++----------- flake.nix | 14 ++++++++++++-- shell.nix | 3 ++- 4 files changed, 28 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d3366247..b2ee152c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,10 +50,7 @@ grcov --branch \ :warning: `grcov` relies on the `llvm-tools-preview` component for `rustup`. For Nix users, `rustup` can interfere with the Rust toolchain -that is provided by Nix, if you have both installed. For convenience, -the `generate-coverage.sh` script can be run from the root of this -repository to avoid contaminating your environment, but note it will -download a full toolchain on each run. +that is provided by Nix, if you have both installed. ## Web site and web playground diff --git a/bin/default.nix b/bin/default.nix index b2b0608f..78429752 100644 --- a/bin/default.nix +++ b/bin/default.nix @@ -1,16 +1,18 @@ { pkgs, writeShellApplication }: { - generate-coverage = writeShellApplication { - name = "generate-coverage"; - - runtimeInputs = with pkgs; [ - cacert - grcov - rustup - ]; - - text = builtins.readFile ./generate-coverage.sh; - }; + # FIXME: Broken + # TODO: Don't use rustup to install these components but just use Nix + # generate-coverage = writeShellApplication { + # name = "generate-coverage"; + + # runtimeInputs = with pkgs; [ + # cacert + # grcov + # rustup + # ]; + + # text = builtins.readFile ./generate-coverage.sh; + # }; playground = writeShellApplication { name = "playground"; diff --git a/flake.nix b/flake.nix index 1d5bfb5f..8dd0e9cb 100644 --- a/flake.nix +++ b/flake.nix @@ -46,8 +46,18 @@ in { packages = { - inherit (topiaryPkgs) topiary-playground topiary-queries client-app; - inherit (binPkgs) generate-coverage playground update-wasm-app update-wasm-grammars verify-documented-usage; + inherit (topiaryPkgs) + topiary-playground + topiary-queries + client-app; + + inherit (binPkgs) + # FIXME: Broken + # generate-coverage + playground + update-wasm-app + update-wasm-grammars + verify-documented-usage; default = topiaryPkgs.topiary-cli; }; diff --git a/shell.nix b/shell.nix index 01936a40..1cabca52 100644 --- a/shell.nix +++ b/shell.nix @@ -13,7 +13,8 @@ craneLib.devShell { rust-analyzer # Our own scripts - generate-coverage + # FIXME: Broken + # generate-coverage playground update-wasm-app update-wasm-grammars