BUG: `rsync` issue with artifact synchronization (`ubuntu-latest`)

[lbajsarowicz]

The issue

After building an artifact (tested with 250MB artifact), Github Action fails with the following error:

[Symfony\Component\Process\Exception\ProcessFailedException]                 
  The command "rsync -azP -e 'ssh -A -p *** -o UserKnownHostsFile=/dev/null  
   -o StrictHostKeyChecking=no' 'artifacts/artifact.tar.gz' 'deploy@ssh.XXX.io:/srv/releases/2009076181'" failed.                

  Exit Code: 255(Unknown error)                                                

  Working directory: /__w/XXX-magento2/XXX-magento2            

  Output:                                                                      
  ================                                                             
  sending incremental file list                                                
  artifact.tar.gz                                                              
         32,768   0%    0.00kB/s    0:00:00                                 

  Error Output:                                                                
  ================                                                                               
  client_loop: send disconnect: Broken pipe                                    

  rsync: [sender] write error: Broken pipe (32)                                
  rsync error: unexplained error (code 2[55](https://github.com/XXX/XXX-magento2/runs/5612222340?check_suite_focus=true#step:7:55)) at io.c(823) [sender=3.2.3]

Conditions

• Usually, the failure happens after the first 3MB.
• The issue does not happen on self-hosted runner

[lbajsarowicz]

Solution

The issue is caused by an invalid rsync configuration. In order to mitigate the issue, you need to add an extra option --bwlimit=... to rsync configuration:

Example:

task('artifact:upload', function () {
    upload(get('artifact_path'), '{{release_path}}', ['options' => ['--bwlimit=4096']]);
});

PS: The issue created for the record / as a solution for others.

[antonmedv]

Awesome! Can you add this to deployphp/deployer docs section?

[lbajsarowicz]

@antonmedv Done.