General

After experimenting with FlowCov locally, you usually want to integrate it into your CI/CD pipeline to automatically generate and upload coverage reports for every build.

On this page, we will outline the steps generally needed to accomplish this. To see specific instructions and examples for your CI vendor, see the following pages:

Versioning

We use tags to make our script available. You can find all of our releases here and all matching tags here. You can download the script by using the following url. Replace the ${TAG} path with the version (or branch name) you want to download, e.g. 0.3.0.

https://bash.flowcov.io/ # Download latest version
https://bash.flowcov.io/${TAG} # Download specific version

If you're using the latest version, you should be careful as your build pipeline may break if we release a new major version that may contain breaking changes.

Executing the script

tip

To use the script as part of your pipeline, you should download it from our servers on every build. You should not download the script and add it to your Git repository.

To download the script for tag 0.3.0 and execute it, you would execute the following command, replacing the repository ID and API key with your own:

$ bash <(curl -s https://bash.flowcov.io/0.3.0) \
-r ${REPOSITORY_ID} \
-a ${API_KEY}

If you specify the repository ID and API key as environment variables FLOWCOV_REPOSITORY_ID and FLOWCOV_API_KEY, you only need this one line instead:

$ bash <(curl -s https://bash.flowcov.io/0.3.0)

If you need to customize the parameters, e.g. by specifying a custom search directory, you can find all available options here.