Way to use "---include-from" in rsync deploy

robertburczak

What is the proper way to use "--include-from" argument in rsync deploy?

In my `bitbucket-pipelines.yml` I have added"

EXTRA_ARGS: '--include-from="deploy-include.txt" --exclude="*"'

Of course I have this file in root of my repository.

Unfortunately I am getting this error:

<span>rsync: failed to open include file "./deploy-include.txt": No such file or directory (2)</span><span>rsync error: error in file IO (code 11) at exclude.c(1207) [client=3.1.3]</span>

ktomk

As you have already noticed, a relative path does not cut the deal here.

And also, rsync-deploy (from: Atlassian / Bitbucket Pipelines Pipes) is not overly talkative about the 

EXTRA_ARGS

shell parameter (also known as environment variable).

however the error message you have at hand is from rsync directly.

for trouble-shooting I would first of all suggest to provide the absolute path for

--include-from=

an absolute path is a path that starts with a slash ("/").

It the file is at the root of your repository another shell parameter named BITBUCKET_CLONE_DIR might be of use here. If pipes support variable substitution (which I hope for but I don't know) this would mean that:

EXTRA_ARGS: '--include-from="$BITBUCKET_CLONE_DIR/deploy-include.txt" --exclude="*"'

or

EXTRA_ARGS: '--include-from="${BITBUCKET_CLONE_DIR}/deploy-include.txt" --exclude="*"'

should work.

If variable substitution is not supported here, another option is to hard-encode the value of it. It was just two days ago when I looked last and my pipeline on Atlassian Bitbucket Cloud showed me

BITBUCKET_CLONE_DIR=/opt/atlassian/pipelines/agent/build

so hard-encoding that value would lead to:

EXTRA_ARGS: '--include-from="/opt/atlassian/pipelines/agent/build/deploy-include.txt" --exclude="*"'

To the best of my knowledge any of these three should cut the deal to you.

I would prefer using the standard parameters like BITBUCKET_CLONE_DIR if possible. Albeit I have not seen the value of it changing over the last couple of months, the intention is more clear with the parameter instead of hard-encoding the value it has now.

Hope this helps. If these suggestions give you (different) errors, please share.