From ca543fc8af4f8f7547ce44119e14e8829bd1c099 Mon Sep 17 00:00:00 2001
From: Darren Schroeder <343840+fdncred@users.noreply.github.com>
Date: Wed, 11 Jan 2023 16:28:30 -0600
Subject: [PATCH] update release-pkg comments for manual runs (#7726)

# Description

After running this script manually again, I found more comments that
needed to be added.

# User-Facing Changes

N/A

# Tests + Formatting

Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A
clippy::needless_collect` to check that you're using the standard code
style
- `cargo test --workspace` to check that all tests pass

# After Submitting

If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
---
 .github/workflows/release-pkg.nu | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)

diff --git a/.github/workflows/release-pkg.nu b/.github/workflows/release-pkg.nu
index 82a569997a..2d65157714 100755
--- a/.github/workflows/release-pkg.nu
+++ b/.github/workflows/release-pkg.nu
@@ -7,18 +7,29 @@
 #   1. https://github.com/volks73/cargo-wix
 
 # Added 2022-11-29 when Windows packaging wouldn't work
-# because softprops/action-gh-release was broken
 # To run this manual for windows
+# unset CARGO_TARGET_DIR if set
+# hide-env CARGO_TARGET_DIR
 # let-env TARGET = 'x86_64-pc-windows-msvc'
 # let-env TARGET_RUSTFLAGS = ''
 # let-env GITHUB_WORKSPACE = 'C:\Users\dschroeder\source\repos\forks\nushell'
+# let-env GITHUB_OUTPUT = 'C:\Users\dschroeder\source\repos\forks\nushell\output\out.txt'
+# let-env OS = 'windows-latest'
+# You need to run this twice. The first pass makes the output folder and builds everything
+# The second pass generates the msi file
 # Pass 1 let-env _EXTRA_ = 'bin'
 # Pass 2 let-env _EXTRA_ = 'msi'
 # make sure 7z.exe is in your path https://www.7-zip.org/download.html
+# let-env Path = ($env.Path | append 'c:\apps\7-zip')
 # make sure aria2c.exe is in your path https://github.com/aria2/aria2
+# let-env Path = ($env.Path | append 'c:\path\to\aria2c')
 # make sure you have the wixtools installed https://wixtoolset.org/
-# set os below like this because it's what github's runner is named
-# let os = 'windows-latest'
+# let-env Path = ($env.Path | append 'C:\Users\dschroeder\AppData\Local\tauri\WixTools')
+# After msi is generated, if you have to update winget-pkgs repo, you'll need to patch the release
+# by deleting the existing msi and uploading this new msi. Then you'll need to update the hash
+# on the winget-pkgs PR. To generate the hash, run this command
+# open target\wix\nu-0.74.0-x86_64-pc-windows-msvc.msi | hash sha256
+# Then, just take the output and put it in the winget-pkgs PR for the hash on the msi
 
 
 # The main binary file to be released