This is a Docker image that is designed for use with Github Actions. It is specifically formulated for use with TypeScript projects, as these projects require a TypeScript runtime for the scanner to operate.

Technically this image will work anywhere, but it sets specific directory structure and environment variables that are designed to conform to the Github Actions architecture.

Go to https://hub.docker.com/r/unbounce/sonarcloud-github-typescript to download the pre-built Docker image.

You need to mount your code into a specific directory structure plus provide a number of environment variable. Use this code snippet as a guide.

docker run \
  -v /path/to/project/code/:/github/workspace/ \
  --env SONAR_LOGIN=... \
  --env GITHUB_REF=<branch name> \
  --env SONAR_ORG=... \
  --env SONAR_PROJECT_KEY=... \
  sonarcloud-github-typescript

Please note that you are supplying this docker run command with a password to your SonarCloud account. This may show up in docker history or bash history commands. Take care where you run this command.

Run make build to build a new image.

You will be unable to tag or release any Docker image unless you have credentials to Unbounce's Docker account.

See LICENSE for details.