action.yml

name: "OX Security Scan"
description: "OX Security Scan as part of your GitHub Actions workflow."
branding:
  icon: check-circle
  color: green
inputs:
  ox_host_url:
    description: 'OX Security application deployment URL.'
    required: false
    default: "https://api.cloud.ox.security"
  ox_api_key:
    description: 'API key generated in the OX Security application.'
    required: true
  ox_scan_full_branch:
    description: 'To scan the entire branch and not only the latest introduced commits, set to `true`.'
    required: false
    default: "false"
  ox_override_blocking:
    description: 'To override a step failure on a blocking issue, set to `true`.'
    required: false
    default: "false"
  ox_timeout:
    description: 'Timeout in minutes after which the OX Security scan will be canceled. If a timeout occurs, step failure will depend on the value of `ox_fail_on_timeout` option.'
    required: false
  ox_fail_on_timeout:
    description: 'To have a scan timeout cause a step failure, set to `true`.'
    required: false
  ox_disable_ssl_validation:
    description: 'If you have an on premise OX Security application deployment and you are using a self-signed certificate, set to `true`.'
    required: false
    default: "false"
  ox_fail_on_error:
    description: 'To have an error (i.e. network, infrastructure) cause a step failure, set to `true`.'
    required: false
  github_repository_id:
    description: 'Repository ID set from context. Do not override.'
    required: false
    default: ${{ github.repository_id }}
  github_repository_url:
    description: 'Repository URL set from context. Do not override.'
    required: false
    default: ${{ github.repositoryUrl }}
  github_pull_request_head_sha:
    description: 'Commit ID for the last commit to the head branch of the pull request set from context. Do not override.'
    required: false
    default: ${{ github.event.pull_request.head.sha }}
runs:
  using: "docker"
  image: "docker://oxsecurity/ox-block-mode:latest"