RC for V1.2

[GuillaumeFalourd]

Description

Closes #2

• Updating the action.yaml file to support Windows OS runners back

Evidences

• MacOS run
• Windows run
• Ubuntu run

https://github.com/GuillaumeFalourd/setup-rsync/actions/runs/6253144375

[koppor]

I tested it. Could not get it to work.

Do you have a hint how to get it running with an ssh-key?

---

Some notes:

sshkey: If the key is written to ./sshkey and chmod 600 ./sshkey it does not work:

Permissions for 'sshkey' are too open.

I tried to use bash for both generation of the key file (/tmp/sshkey) and for executing rsync. If rsync was executed in cmd.exe, it could not access /tmp/sshkey. However, the bash one also could not access that file. Maybe /tmp is cleaned up between sessions?

I tried ~/sshkey as SSH key file: /home/runneradmin/sshkey - No such file or directory

(Other hints on ssh keys are given at https://maxschmitt.me/posts/github-actions-ssh-key - however, I don't want to use an agent)

---

Just as reference - with chocolatey, everything works:

rsync installation takes about 30 seconds ( choco install rsync):

There, the permission issue with the ssh key does not occur.

Part of the command:

-e 'C:\ProgramData\chocolatey\lib\rsync\tools\bin\ssh.exe -i sshkey -o StrictHostKeyChecking=no'

Note the special location of ssh.exe. Source: https://serverfault.com/a/1053949/107832

Maybe, you could switch from the "invasive" cygwin installation to a simple choco installation? Maybe, the action can be paramterized: windowsdistribution: cygwin|chocolatey, which cygwin as default (to be backward compatible).

[koppor]

I gave up with cygwin and ssh. Tried around with '${{runner.temp}}/sshkey', but still

Warning: Identity file D:\a\_temp/sshkey not accessible: No such file or directory.

With some more work:

      - name: Setup ssh key
        shell: bash
        run: |
          temp_path="${{ runner.temp }}"
          temp_path="${temp_path//\\//}"
          echo "${{ secrets.SSH_KEY }}" > "${temp_path}/sshkey"
          chmod 600 "${{runner.temp}}/sshkey"
      - name: rsync
        shell: bash
        run: |
          temp_path="${{ runner.temp }}"
          sshkeypath="${temp_path//\\//}/sshkey"
          rsync -Pavz --itemize-changes --stats --partial-dir=/tmp/partial --rsync-path="mkdir -p /tmp/test && rsync" -e "ssh -i ${sshkeypath} -o StrictHostKeyChecking=no" build/distribution/ user@example.org:/tmp/test/

But then

D:\a\_temp\0628137d-dcd0-4df7-88cf-7c626c38454f.sh: line 30: D:/a/_temp

/sshkey

Will use choco install rsync

[koppor]

My job:

jobs:
  rsynctest:
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
    runs-on: ${{ matrix.os }}
    steps:
      - name: Setup rsync
        uses: GuillaumeFalourd/setup-rsync@test
      - name: Setup ssh key
        shell: bash
        run: |
          temp_path="${{ runner.temp }}"
          temp_path="${temp_path//\\//}"
          echo "${{ secrets.SSH_KEY }}" > "${temp_path}/sshkey"
          chmod 600 "${{runner.temp}}/sshkey"
          mkdir -p build/distribution/
          touch build/distribution/test.txt
      - name: rsync
        shell: bash
        run: |
          temp_path="${{ runner.temp }}"
          sshkeypath="${temp_path//\\//}/sshkey"
          rsync -Pavz --itemize-changes --stats --partial-dir=/tmp/partial --rsync-path="mkdir -p /tmp/test && rsync" -e "ssh -i ${sshkeypath} -o StrictHostKeyChecking=no" build/distribution/ user@example.org:/tmp/test/

[GuillaumeFalourd]

Hi @koppor , thank you for the insights!

I'll move the action to use choco instead for windows in that case.

EDIT: Seems to work, as can be seen here

Would you find it helpful to have a not mandatory ssh key input to execute the following command during the action execution?

     run: |
          temp_path="${{ runner.temp }}"
          temp_path="${temp_path//\\//}"
          echo "${{ secrets.SSH_KEY }}" > "${temp_path}/sshkey"
          chmod 600 "${{runner.temp}}/sshkey"

[koppor]

Some small comments.

I would also modify the test workflow - one can use a local action.yml after checkout as action. See https://github.com/orgs/community/discussions/26245 for details.

[koppor]

This always outputs that rsync is installed. Maybe, skip installation - and if GitHub updates the image - and removes rsync, this action can be updated.

[GuillaumeFalourd]

I would still let this part here as this action could be used on self-hosted runner that may not have rsync installed by default.

[koppor]

Does one need apt-get update before? - On "normal" docker images, this is required, because the indexes are normally wiped away to save space.

Some bookmarks to share:

• Run GitHub actions locally: https://github.com/nektos/act
  • (rather small) Image with sudo: https://github.com/fwilhe2/act-runner-image
  • act --rm --platform ubuntu-latest=fwilhe2/act-runner:latest -W Tests

[GuillaumeFalourd]

I've update this section in the action.yaml file if you want to have a look 👍🏼

[koppor]

I think, this did not work on Cygwin bash. Hopefully, it does on git bash.

[GuillaumeFalourd]

Is there a way to identify if it's using cygwin or git before executing those commands?

[koppor]

The environment variable CYGWIN is set in the case of the former.

[GuillaumeFalourd]

I've update this section in the action.yaml file if you want to have a look 👍🏼

[koppor]

Would you find it helpful to have a not mandatory ssh key input to execute the following command during the action execution?

Sure!

It would also be great if the path to the sshkey would be available as output of the action. In that way, one can "easily" use it as input for -i for rsync.

[GuillaumeFalourd]

Would you find it helpful to have a not mandatory ssh key input to execute the following command during the action execution?

Sure!

It would also be great if the path to the sshkey would be available as output of the action. In that way, one can "easily" use it as input for -i for rsync.

I'll add it 👍🏼

EDIT: Done