-
You must retrieve a FOSSA API token. This is found in FOSSA under Account Settings
-
You must set this as an environment variable named
FOSSA_API_TOKEN
in your Circle CI build -
Add a custom build step in your
circle.yml
file like so: 1.0:test: pre: -cd /tmp && git clone https://github.com/fossas/fossa-circleci-plugin && cd fossa-circleci-plugin && npm i && node index.js
2.0:
- run: command: | cd /tmp; git clone https://github.com/fossas/fossa-circleci-plugin; cd fossa-circleci-plugin; npm i; node index.js; no_output_timeout: '30m' name: 'Check FOSSA Build/Scan'
-
(optional) Set a timeout for pinging the FOSSA API. By default, timeout is 30 minutes. This can be set via the Environment variable:
FOSSA_POLL_TIMEOUT
. You must specify in milliseconds, ex:1000 * 60 * 30
(30 minutes)
You can set a custom fossa endpoint url as well with Env variable: FOSSA_ENDPOINT_URL