A broken symlink in the package makes it impossible to deploy it as part of a CI/CD pipeline

[asiby]

(edit: Typos)

Problem

The /docs directory is not part of the installed files after running composer. That makes the /README.rst link invalid.

Consequence

During a deployment, we have chosen to run composer in a pipeline. During that process, when the broken symlink is encountered by the aws cli (for example), we get No such file or directory and the deployment fails.

Mitigation / Workaround

Delete /README.rst right after running composer install

Proposed solution

• Do no include any symlink in a library, a repo, etc.
• In this case, replace README.rst with the actual file from the /docs directory.

[jparise]

Sorry about that! Fixed in version 1.9.2.

[asiby]

Thanks