This article will show you how to integrate ShiftLeft CORE's NG SAST into your GitHub Pull Request (PR) workflow for automated code analysis using GitHub Actions.
This article assumes that you have an existing GitHub repository to which you would like to add NG SAST for automated code analysis.
Step 1: Create your secrets
GitHub's secrets are encrypted environment variables that protect information while making them available for use in GitHub Actions workflows. They are specific to your GitHub repository.
To create secrets specific to your GitHub repository:
- Navigate to your GitHub repo.
- Go to Settings > Secrets > Actions.
- Click New repository secret.
- Create a secret named
SHIFTLEFT_ACCESS_TOKENand provide the value of your CI token.
If you add NG SAST functionality to multiple repos, you may want to create encrypted secrets for an organization. This allows you to create secrets once for use across multiple repos.
Step 2: Create your GitHub Action and define its workflow
GitHub Actions offers you workflow automation functionality. You can use this to automatically run NG SAST (e.g., when you create a new Pull Request).
To create a new GitHub Action for your repository, click Actions. If this is your first time setting up a GitHub Action, click set up a workflow yourself near the top-left; otherwise, click New workflow, then select set up a workflow yourself.
You will be redirected to a YAML editing window. Rename the file (if desired), and provide the following script to invoke NG SAST.
When done, click Start commit and follow the prompts to commit the file to your repo.
You'll see your newly configured workflow listed under the repository's Actions.
Scheduling your code analysis for regular scans
GitHub Actions allows you to schedule jobs to run regularly. You may opt for such a setup to ensure that you are consistently scanning the main branch and therefore have an up-to-date version of code analysis results against which you can compare your scans (e.g., those performed by developers as they work on their projects).
To schedule a regular ShiftLeft scan, use the
schedule event. The following snippet shows how you can schedule a job to run every day at 5:30 and 17:30 UTC:
Your updated config file to run ShiftLeft would be:
Step 3: Test Your Workflow
At this point, you're done with the configuration steps. You can check whether you successfully set up the GitHub Action by triggering the workflow (e.g., by creating a Pull Request).
You can click Status for additional details about the workflow's progress:
When done, you can see a summary of NG SAST's results on the PR:
You can get full details regarding the analysis from the ShiftLeft Dashboard.