Overview

In this article we will make the necessary modifications to a simple AWS CodeBuild project to scan a GitHub repository with SOOS.

Integration Steps

Open the SOOS App, browse to Integrate > CI/CD/Repo > CI/CD > AWS CodeBuild

  • Click the "Download" link and get the latest release of the soos.py and requirements.txt files

  • Create the following directory structure in your root codebase "soos/workspace"

  • Place the soos.py and requirements.txt files under the "soos" directory

Technical details for the script can be found here: https://github.com/soos-io/soos-ci-analysis-python

Note the API Key and Client ID values, you will need these below.

Repo Setup

  1. Create a new folder in your GitHub repository: <repo_root>/soos/workspace/
  2. Place the requirements.txt and soos.py files <repo_root>/soos/ folder that you created in step # 1 above.
  3. Commit these 2 new files and the new folder path to GitHub.

Configure CodeBuild

Edit The Project

Navigate to your Project and select “Environment” from the “Edit” menu.

edit your project

Setup Environment Variables

Open “Additional Configuration” to reveal the “Environment Variables” section. In the “Environment Variables” section, create the SOOS_API_KEY and SOOS_CLIENT_ID environment variables. These will serve as environment variables to be used by the Package Aware CLI. Use the API Key and Client ID values you collected from the SOOS App.


environment variables

Set Build Commands

Return to the 'Edit' menu and select Buildspec to insert build commands.  Add the script provided in the AWS Integration page in the SOOS App and select “Update Buildspec”.

update build

Run It

To run the SOOS CLI against your repository’s code, just execute a build or commit a change. The build will use the environment variables that you created for the API Key and Client ID.