fission / fission-workflows

Workflows for Fission: Fast, reliable and lightweight function composition for serverless functions
Apache License 2.0
371 stars 42 forks source link

Update compiling instructions and rename potential conflicting wfcli directory #171

Closed erwinvaneyk closed 6 years ago

erwinvaneyk commented 6 years ago

Based on feedback of @soamvasani, the instructions for compiling are too ambiguous. Since writing the instructions the build/wfcli directory was added, causing users that followed the compiling.md instructions literally to hit the following error when building:

go install github.com/fission/fission-workflows/cmd/wfcli: build output "wfcli" already exists and is a directory

This error is caused because the build artifact (wfcli) conflicts with the build/wfcli when building from the build/ directory. Building from any other directory would not cause this error.

To fix this issue, I...

  1. renamed build/wfcli to build/wfcli-docker to avoid the naming conflict
  2. updated the compiling.md instructions to reflect the current state and also be more thorough in explaining the options.