From 11b242354472965e709fbedbd4775cfbffa8d393 Mon Sep 17 00:00:00 2001
From: Darren Schroeder <343840+fdncred@users.noreply.github.com>
Date: Wed, 30 Nov 2022 20:18:28 -0600
Subject: [PATCH] add comments to release-pkg for manual running (#7277)

# Description

This PR is just some comments in the release-pkg.nu script. We had to
figure out how to run it manually so I thought it would be good to
document those requirements just in case we need to do it again
sometime.

# 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 | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/.github/workflows/release-pkg.nu b/.github/workflows/release-pkg.nu
index 859fb6a814..2c5a5cd818 100755
--- a/.github/workflows/release-pkg.nu
+++ b/.github/workflows/release-pkg.nu
@@ -6,6 +6,21 @@
 # REF:
 #   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
+# let-env TARGET = 'x86_64-pc-windows-msvc'
+# let-env TARGET_RUSTFLAGS = ''
+# let-env GITHUB_WORKSPACE = 'C:\Users\dschroeder\source\repos\forks\nushell'
+# 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
+# make sure aria2c.exe is in your path https://github.com/aria2/aria2
+# 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'
+
+
 # The main binary file to be released
 let bin = 'nu'
 let os = $env.OS