Add more details to the Holochain upgrade guide

[ThetaSinner]

No description provided.

[steveej]

thanks, i'm sure this will help lots of devs. i added some non-critical suggestions.

[steveej]

i like this honest preface

[c12i]

Great documentation and very easy to follow

Something to consider though, the package.json scripts in 0.1 and 0.2 vary with regards to calling hc run-local-services in the launch script which was not done before in 0.1. Running this command also requires that BOOTSTRAP_PORT and SIGNAL_PORT are set in the start script so that they are referenced in the launch script

Here is an example

0.1:

  "scripts": {
    "start": "AGENTS=2 npm run network",
    "network": "hc s clean && npm run build:happ && UI_PORT=8888 concurrently \"npm start -w ui\" \"npm run launch:happ\" \"holochain-playground\"",
    "test": "npm run build:zomes && hc app pack workdir --recursive && npm t -w tests",
    "launch:happ": "hc-spin -n $AGENTS --ui-port $UI_PORT workdir/{{app_name}}.happ",
    "start:tauri": "AGENTS=2 npm run network:tauri",
    "network:tauri": "hc s clean && npm run build:happ && UI_PORT=8888 concurrently \"npm start -w ui\" \"npm run launch:tauri\" \"holochain-playground\"",
    "launch:tauri": "echo \"pass\" | RUST_LOG=warn hc launch --piped -n $AGENTS workdir/{{app_name}}.happ --ui-port $UI_PORT network mdns",
    "package": "npm run build:happ && npm run package -w ui && hc web-app pack workdir --recursive",
    "build:happ": "npm run build:zomes && hc app pack workdir --recursive",
    "build:zomes": "RUSTFLAGS='' CARGO_TARGET_DIR=target cargo build --release --target wasm32-unknown-unknown"
  }

0.2

  "scripts": {
    "start": "AGENTS=2 BOOTSTRAP_PORT=$(port) SIGNAL_PORT=$(port) npm run network",
    "network": "hc s clean && npm run build:happ && UI_PORT=8888 concurrently \"npm start -w ui\" \"npm run launch:happ\" \"holochain-playground\"",
    "test": "npm run build:zomes && hc app pack workdir --recursive && npm t -w tests",
    "launch:happ": "hc-spin -n $AGENTS --ui-port $UI_PORT workdir/{{app_name}}.happ",
    "start:tauri": "AGENTS=2 BOOTSTRAP_PORT=$(port) SIGNAL_PORT=$(port) npm run network:tauri",
    "network:tauri": "hc s clean && npm run build:happ && UI_PORT=8888 concurrently \"npm start -w ui\" \"npm run launch:tauri\" \"holochain-playground\"",
    "launch:tauri": "concurrently \"hc run-local-services --bootstrap-port $BOOTSTRAP_PORT --signal-port $SIGNAL_PORT\" \"echo pass | RUST_LOG=warn hc launch --piped -n $AGENTS workdir/{{app_name}}.happ --ui-port $UI_PORT network --bootstrap http://127.0.0.1:\"$BOOTSTRAP_PORT\" webrtc ws://127.0.0.1:\"$SIGNAL_PORT\"\"",
    "package": "npm run build:happ && npm run package -w ui && hc web-app pack workdir --recursive",
    "build:happ": "npm run build:zomes && hc app pack workdir --recursive",
    "build:zomes": "RUSTFLAGS='' CARGO_TARGET_DIR=target cargo build --release --target wasm32-unknown-unknown"
  }

I am not sure whether excluding hc run-local-services will have any effect in running the happ though

[ThetaSinner]

Hmm, that's an interesting one @c12i, when I scaffolded today I got a project that has hc-spin in for launching apps which wasn't the case for most people scaffolding a project - so documenting the diff in the package.json is going to be tricky...

I wonder if it's worth suggesting that people scaffold a project using 0.2 and diff it against their project to see if there are other changes they want? For example this project looks like it might have started from the scaffolding but has diverged quite a bit on scripts so it'd be hard to advise them what to do about resolving differences

[ThetaSinner]

One more thing that might be worth mentioning actually is the Node.js upgrade. People will be on 18 but should ideally move to 20

[ThetaSinner]

Added Node.js instructions

[ThetaSinner]

Or actually @c12i, maybe I just scaffold a 0.2 app and include the scripts in this doc? Then people can diff against it with a bit less work... that does mean that future updates to the scripts will be missed but it might be a helpful way to get the initial move from 0.1 to 0.2 done smoothly

[c12i]

I got a project that has hc-spin in for launching apps which wasn't the case for most people scaffolding a project

Yep this is a very recent change, I assume older happs on 0.1 will still be relying on hc launch to launch their apps, this version doesn't require hc run-local-services to be called.

Documenting the diff will be tricky indeed, I think what I can suggest would be to add hc-spin as a dev dependency and update the launch script to move away from hc launch to hc-spin like so hc-spin -n $AGENTS --ui-port $UI_PORT workdir/{{app_name}}.happ

[ThetaSinner]

Cool, I'll give that a go and see what you think :)

[c12i]

Should have mentioned the version of hc-spin to use with 0.2 btw, here it is ^0.200.10

[ThetaSinner]

I can update that, but the command I'm giving will install the latest version of 0.2000.x for hc-spin, I'm trying to make as few of the commands as I can require thought from the user about what to change

[c12i]

looking good now 👍🏽