dev tools quick-install script: Paul's changes #373
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for hc-doc-pages-wip ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
steveej
approved these changes
Feb 22, 2023
Co-authored-by: Stefan Junker <[email protected]>
steveej
suggested changes
Feb 22, 2023
|
|
||
| If you want to re-enter the shell to do more work, or create multiple terminals to work in, you'll need to re-enter the `nix develop` in each new instance. The packages are cached locally on your machine, so they will be ready the next time you enter the shell. You do need to get the package configuration files from somewhere, though. If you use the Holochain repo cloning method, they're cached on your machine too, but the ['quick install'](../install/) and ['using a specific version'](#using-a-specific-version-of-the-development-tools) methods require an internet connection every time you want to enter the shell. | ||
| If you want to do more work, or create multiple terminals to work in, you'll need to re-enter the `nix develop` shell in each new instance. The packages are cached locally on your machine, so they will be ready the next time you enter the shell. If you follow the practices above to create a per-project `flake.nix` file, you can work completely offline, but you need an internet connection in order to enter the [ad-hoc shell](#holonix%27s-usage-of-nix%27s-flakes-features). If you're going to be working offline, you can [download a snapshot of the holochain GitHub repository](https://github.com/holochain/holochain/archive/refs/heads/develop.zip) and enter the shell once using the contained `flake.nix`. After that, the packages will be cached and you can continue to use this flake for ad-hoc shells. |
There was a problem hiding this comment.
re-reading this it's actually somewhat confusing. specifically, in my mind the offline instructions mentioning the snapshot and its flake.nix blur into setting up a custom flake.nix and working offline with that. this paragraph just seems to try to cram too much information in it.
There was a problem hiding this comment.
yeah, fair enough. Is there a skeleton flake.nix that we can put there instead?
And also -- is it actually true that this is all you need in order to work offline? Just have a local flake.nix and enter it once while you're online?
There was a problem hiding this comment.
Suggested change
| If you want to do more work, or create multiple terminals to work in, you'll need to re-enter the `nix develop` shell in each new instance. The packages are cached locally on your machine, so they will be ready the next time you enter the shell. If you follow the practices above to create a per-project `flake.nix` file, you can work completely offline, but you need an internet connection in order to enter the [ad-hoc shell](#holonix%27s-usage-of-nix%27s-flakes-features). If you're going to be working offline, you can [download a snapshot of the holochain GitHub repository](https://github.com/holochain/holochain/archive/refs/heads/develop.zip) and enter the shell once using the contained `flake.nix`. After that, the packages will be cached and you can continue to use this flake for ad-hoc shells. | |
| If you want to do more work, or create multiple terminals to work in, you'll need to re-enter the `nix develop` shell in each new instance. The packages are cached locally on your machine, so they will be ready the next time you enter the shell. If you follow the practices above to create a per-project `flake.nix` file, you can work completely offline, but you need an internet connection in order to enter the [ad-hoc shell](#holonix%27s-usage-of-nix%27s-flakes-features). If you're going to be working offline, you can copy the following code into a `flake.nix` file, then enter the shell using `nix run flake.nix#holonix` once before you go offline. The packages will all be cached, and you can use the same command to enter an ad-hoc shell while you are offline. | |
| ```nix | |
| inputs = { | |
| holochain-flake = { | |
| url = "github:holochain/holochain"; | |
| }; | |
| }; |
just a wild guess that this would work ☝🏼 testing my understanding by writing code for review!!
There was a problem hiding this comment.
nope, doesn't work. The files are cached and you can enter a per-project nix develop shell while offline (albeit with a few spurious errors), but that skeleton didn't do anything productive.
jost-s
requested changes
Feb 22, 2023
|
|
||
| Each Holochain application repository will contain its own setup of the development environment. | ||
| If you use the scaffolding to generate the project structure, this will already be taken care of in the scaffolded directory. | ||
|
|
||
| If you want to learn more about how this setup works and how to create it manually and how to maintain it, please find all the information below. | ||
|
|
||
| ### Holonix's usage of [Nix's Flakes](https://nixos.wiki/wiki/Flakes) features |
There was a problem hiding this comment.
Suggested change
| ### Holonix's usage of [Nix's Flakes](https://nixos.wiki/wiki/Flakes) features | |
| ### Holonix's usage of [Nix Flakes](https://nixos.wiki/wiki/Flakes) features |
|
|
||
| The flake follows (think inherits) the `nixpkgs` input of the `holochain-flake` input. This ensures that your development environment passes all the same buildinputs to the component packages, giving you very high chances to make use of our Cachix binary cache. | ||
| This flake declares one input named `holochain-flake` that the Holochain Github repository. This input will look for a `flake.nix` in the default branch of the remote repository. The `versions` input of the `holochain-flake` input is explicitly specified to track the _0_1_ series, which refers to Holochain's Beta 0.1 and its compatible tools. |
There was a problem hiding this comment.
Suggested change
| This flake declares one input named `holochain-flake` that the Holochain Github repository. This input will look for a `flake.nix` in the default branch of the remote repository. The `versions` input of the `holochain-flake` input is explicitly specified to track the _0_1_ series, which refers to Holochain's Beta 0.1 and its compatible tools. | |
| This flake declares one input named `holochain-flake` that represents the Holochain Github repository. This input will look for a `flake.nix` in the default branch of the remote repository. The `versions` input of the `holochain-flake` input is explicitly specified to track the _0_1_ series, which refers to Holochain's Beta 0.1 and its compatible tools. |
| The flake follows (think inherits) the `nixpkgs` input of the `holochain-flake` input. This ensures that your development environment passes all the same buildinputs to the component packages, giving you very high chances to make use of our Cachix binary cache. | ||
| This flake declares one input named `holochain-flake` that the Holochain Github repository. This input will look for a `flake.nix` in the default branch of the remote repository. The `versions` input of the `holochain-flake` input is explicitly specified to track the _0_1_ series, which refers to Holochain's Beta 0.1 and its compatible tools. | ||
|
|
||
| The flake follows (think _inherits_) the `nixpkgs` input of the `holochain-flake` input. This ensures that your development environment passes all the same buildinputs to the component packages, giving you very high chances to make use of our Cachix binary cache. |
There was a problem hiding this comment.
Suggested change
| The flake follows (think _inherits_) the `nixpkgs` input of the `holochain-flake` input. This ensures that your development environment passes all the same buildinputs to the component packages, giving you very high chances to make use of our Cachix binary cache. | |
| The flake follows (think _inherits_) the `nixpkgs` input of the `holochain-flake` input. This ensures that your development environment passes all the same build inputs to the component packages, giving you very high chances to make use of our Cachix binary cache. |
There was a problem hiding this comment.
but it's one word, even though a compound one 🤔 maybe build-inputs?
There was a problem hiding this comment.
In plain English it's not one word. If you want to use syntax, then put it in "quotes" or in back ticks.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.