Module: Octokit::Client::CodeScanning

Included in:

Octokit::Client

Defined in:

lib/octokit/client/code_scanning.rb

Overview

Methods for the code scanning alerts API

See Also:

• https://docs.github.com/rest/code-scanning

Instance Method Summary

• #get_sarif_upload_information(repo, sarif_id, options = {}) ⇒ Sawyer::Resource

  Gets information about a SARIF upload.

• #upload_sarif_data(repo, file, sha, ref, options = {}) ⇒ Sawyer::Resource

  Uploads SARIF data containing the results of a code scanning analysis.

Instance Method Details

#get_sarif_upload_information(repo, sarif_id, options = {}) ⇒ Sawyer::Resource

Gets information about a SARIF upload

Parameters:

• repo (Integer, String, Repository, Hash) —

  A GitHub repository

• sarif_id (String) —

  The SARIF ID obtained after uploading

Returns:

• (Sawyer::Resource) —

  SARIF upload information

See Also:

• https://docs.github.com/rest/code-scanning#get-information-about-a-sarif-upload

# File 'lib/octokit/client/code_scanning.rb', line 37

def get_sarif_upload_information(repo, sarif_id, options = {})
  get "#{Repository.path repo}/code-scanning/sarifs/#{sarif_id}", options
end

#upload_sarif_data(repo, file, sha, ref, options = {}) ⇒ Sawyer::Resource

Uploads SARIF data containing the results of a code scanning analysis

Parameters:

• repo (Integer, String, Repository, Hash) —

  A GitHub repository

• file (String) —

  Path to the SARIF file to upload

• sha (String) —

  The SHA of the commit to which the analysis you are uploading relates

• ref (String) —

  The full Git reference, formatted as refs/heads/<branch name>, refs/pull/<number>/merge, or refs/pull/<number>/head

Returns:

• (Sawyer::Resource) —

  SARIF upload information

See Also:

• https://docs.github.com/rest/code-scanning#upload-an-analysis-as-sarif-data

# File 'lib/octokit/client/code_scanning.rb', line 22

def upload_sarif_data(repo, file, sha, ref, options = {})
  options[:sarif] = compress_sarif_data(file)
  options[:commit_sha] = sha
  options[:ref] = ref

  post "#{Repository.path repo}/code-scanning/sarifs", options
end