From d47d818ab7df2fba3488bb41e64b26c4e3424190 Mon Sep 17 00:00:00 2001 From: appleboy Date: Fri, 21 Jul 2023 22:49:16 +0800 Subject: [PATCH] docs: improve OpenSSH setup and usage instructions - Corrected a typo in the instructions for changing the default OpenSSH shell to git bash - Added instructions to set `tar_dereference` and `rm` variable to `true` in the YAML file - Advised against putting the `port` value through a variable - Provided guidance on converting the target path to a Unix path: `/c/path/to/target/` Signed-off-by: appleboy --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d65dc95..2e38d9b 100644 --- a/README.md +++ b/README.md @@ -310,16 +310,23 @@ Protecting a Private Key. The purpose of the passphrase is usually to encrypt th source: "tests/a.txt,tests/b.txt" target: your_server_target_folder_path ``` + When copying files from a Linux runner to a Windows server, you should: -1. Download git for Windows -2. Change the default OpenSSH shell to git bach with the following powershell command: +1. Download git for Windows +2. Change the default OpenSSH shell to git bach with the following powershell command. +3. Set `tar_dereference` and `rm` variable to `true` in the YAML file +4. Avoid putting the `port` value through a variable +5. Convert the target path to a Unix path: `/c/path/to/target/` + +Change the default OpenSSH shell to git bach with the following powershell command. + ```powershell New-ItemProperty -Path "HKLM:\SOFTWARE\OpenSSH" -Name DefaultShell -Value "$env:Programfiles\Git\bin\bash.exe" -PropertyType String -Force ``` -3. Set `tar_dereference` and `rm` variable to `true` in the YAML file -4. Avoid putting the `port` value through a variable -5. Convert the target path to a Unix path: + +Convert the target path to a Unix path: `/c/path/to/target/` + ```diff - name: Copy to Windows uses: appleboy/scp-action@v0.1.4 @@ -333,4 +340,4 @@ New-ItemProperty -Path "HKLM:\SOFTWARE\OpenSSH" -Name DefaultShell -Value "$env: + target: '/c/path/to/target/' + tar_dereference: true + rm: true -``` +```