github upload-results

This content describes the most recent release of the CodeQL CLI. For more information about this release, see https://github.com/github/codeql-cli-binaries/releases.

To see details of the options available for this command in an earlier release, run the command with the --help option in your terminal.

Sinopse

Shell

codeql github upload-results --sarif=<file> [--github-auth-stdin] [--github-url=<url>] [--repository=<repository-name>] [--ref=<ref>] [--commit=<commit>] [--checkout-path=<path>] <options>...

Descrição

Carrega um arquivo SARIF na verificação de código do GitHub.

Confira: https://docs.github.com/en/code-security/secure-coding/running-codeql-cli-in-your-ci-system#uploading-results-to-github

Um token dos GitHub Apps ou um token de acesso pessoal precisa ser definido. Para as melhores práticas de segurança, recomendamos definir o sinalizador --github-auth-stdin e transmitir o token para o comando por meio da entrada padrão. Como alternativa, a variável de ambiente GITHUB_TOKEN pode ser definida.

O token precisa ter o escopo security_events.

Opções principais

`-s, --sarif=<file>`

[Obrigatório] Caminho para o arquivo SARIF a ser carregado. Essa deve ser a saída de codeql database analyze (ou de codeql database interpret-results) com --format sarif-latest para upload no github.com ou no GitHub AE, ou a tag de formato com suporte apropriada para as instâncias do GitHub Enterprise Server (confira https://docs.github.com/ para ver o valor certo para sua versão).

`-r, --repository=<repository-name>`

Proprietário e nome do repositório do GitHub (por exemplo, github/octocat) a serem usados como um ponto de extremidade para o upload. A CLI tentará fazer a detecção automática disso usando o caminho de check-out se ele for omitido.

`-f, --ref=<ref>`

Nome da referência que foi analisada. Se essa referência for um commit de mesclagem de solicitação de pull, use refs/pulls/1234/merge ou refs/pulls/1234/head (dependendo se esse commit corresponde ao commit HEAD ou MERGE da PR). Caso contrário, isso deve ser um branch: refs/heads/branch-name. Se isso for omitido, a CLI tentará preenchê-lo automaticamente por meio do branch atual do caminho de check-out, se houver.

`-c, --commit=<commit>`

SHA do commit que foi analisado. Se isso for omitido, a CLI tentará fazer a detecção automática disso por meio do caminho de check-out.

`-p, --checkout-path=<path>`

Caminho do check-out. O padrão é o diretório de trabalho atual.

`--merge`

[Avançado] Permita que mais de um arquivo SARIF seja especificado e mescle-os em um só arquivo antes do upload. Isso só é recomendado para compatibilidade com versões anteriores. Para novas análises, recomendamos carregar dois arquivos SARIF separados com categorias diferentes. Essa opção só funciona em conjunto com arquivos SARIF produzidos pelo CodeQL com o SARIF versão 2.1.0 (esta é a versão padrão do SARIF usada pelo CodeQL).

`--format=<fmt>`

Selecione o formato de saída. As opções incluem:

text (padrão) : imprima a URL para acompanhar o status do upload SARIF.

json: imprima o corpo da resposta da solicitação de API de upload SARIF.

Consulte também: https://docs.github.com/en/rest/reference/code-scanning#upload-an-analysis-as-sarif-data

Opções para configurar o local em que os arquivos SARIF serão carregados.

`-a, --github-auth-stdin`

Aceite um token do GitHub Apps ou um token de acesso pessoal por meio da entrada padrão.

Isso substitui a variável de ambiente GITHUB_TOKEN.

`-g, --github-url=<url>`

URL da instância do GitHub a ser usada. Se isso for omitido, a CLI tentará fazer a detecção automática dela por meio do caminho do check-out e, se isso não for possível, usará https://github.com/ como padrão

Opções comuns

`-h, --help`

Mostre este texto de ajuda.

`-J=<opt>`

[Avançado] Forneça a opção para a JVM que executa o comando.

(Use-a com cautela, pois as opções que contêm espaços não serão tratadas corretamente.)

`-v, --verbose`

Aumente incrementalmente o número de mensagens de progresso impressas.

`-q, --quiet`

Diminua incrementalmente o número de mensagens de progresso impressas.

`--verbosity=<level>`

[Avançado] Defina explicitamente o nível de detalhamento como erros, avisos, progresso, progresso+, progresso++ ou progresso+++. Substitui -v e -q.

`--logdir=<dir>`

[Avançado] Escreva logs detalhados em um ou mais arquivos no diretório fornecido, com nomes gerados que incluem carimbos de data/hora e o nome do subcomando em execução.

(Para gravar um arquivo de log com um nome sobre o qual você tem controle completo, forneça --log-to-stderr e redirecione stderr conforme desejado.)

github upload-results

Neste artigo