Skip to content

Latest commit

 

History

History

workflows

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
config
config
 
 
README.md
README.md
 
 
dockerbuild.yml
dockerbuild.yml
 
 
secrets-scan.yml
secrets-scan.yml
 
 
semgrep.yml
semgrep.yml
 
 

README.md

SkyScan GitHub Workflows

Overview

SkyScan and associated projects use a number of GitHub action workflows to verify code security, secrets integrity, and provide project building and deployment capability. These workflows and their required secrets and configuration variables are detailed below.

For information on adding configuration variables and secrets, see the GitHub Actions documentation here and here.

Docker Container Building

SkyScan uses the action outlined in dockerbuild.yml to automatically build Dockerfiles located in the project and push them to Docker Hub. This action is triggered everytime there is a push to the main branch.

Secrets

  • DOCKER_USERNAME (required) - The login username for Docker Hub.
  • DOCKER_NAMESPACE (required) - The Docker Hub account that this image will be pushed to. The DOCKER_USERNAME Docker Hub user must have write permissions to DOCKER_NAMESPACE. Oftentimes they are the same value.
  • DOCKER_TOKEN (required) - A Docker Hub personal access token associated with the DOCKER_USERNAME account.

Configuration Variables

  • PROJECT_NAME (required) - The overarching name of the project.
  • DOCKER_BUILD_PLATFORMS (optional, defaults to linux/amd64) - A comma separated list of the target platforms the images will be built for.
  • DOCKER_BUILD_FOLDERS (optional, defaults to .) - A comma separated list of folders under the main repository containing Dockerfiles to be built.