Skip to content

Commit

Permalink
chore: mark generate-coverage as broken, and remove reference to it i…
Browse files Browse the repository at this point in the history
…n README
  • Loading branch information
Erin van der Veen committed Apr 4, 2024
1 parent edb9f60 commit 18fd74a
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 18 deletions.
5 changes: 1 addition & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
24 changes: 13 additions & 11 deletions bin/default.nix
Original file line number Diff line number Diff line change
@@ -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";
Expand Down
14 changes: 12 additions & 2 deletions flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -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;
};
Expand Down
3 changes: 2 additions & 1 deletion shell.nix
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ craneLib.devShell {
rust-analyzer

# Our own scripts
generate-coverage
# FIXME: Broken
# generate-coverage
playground
update-wasm-app
update-wasm-grammars
Expand Down

0 comments on commit 18fd74a

Please sign in to comment.