holochain / holochain/holonix

Document how to use sweettest in Holonix

Open
#71 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Nix
Stars
7
Forks
3
Avg merge
1d 22h
Merged PRs (30d)
8

Description

When you get Holochain/Lair through Holonix, the builds are defined so that you get the right libraries provided on supported platforms.

However, if you use sweettest then you are going to have to rebuild most of the code for both, so you actually need to provide the same Nix packages in your dev shell to run those tests.

We have an example of how this is done over here https://github.com/holochain/tryorama/blob/main/flake.nix#L42

Should we provide these libraries for everyone so this just works/ Ideally not because that's a lot of extra bandwidth for most projects that don't use sweettest.
Or should we just document what to change in your flake if you want to use sweettest? I prefer that option

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the example in tryorama/flake.nix around line 42 to understand which Nix packages sweettest requires. Document the corresponding dev-shell changes for Holonix users, including when they are needed and why the libraries are not provided by default.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.