github upload-results

Note

Este conteúdo descreve a versão mais recente do CodeQL CLI. Para obter mais informações sobre essa versão, confira https://github.com/github/codeql-cli-binaries/releases.

Para ver os detalhes das opções disponíveis para esse comando em uma versão anterior, execute o comando com a opção --help no 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>...

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: Como carregar os resultados da análise do CodeQL no 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

Opções primárias

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

[Obrigatório] Caminho para os arquivos SARIF a serem usados. Essa deve ser a saída da análise de banco de dados codeql (ou dos resultados de interpretação do banco de dados codeql) com --format sarif-latest para upload no github.com ou a tag de formato com suporte apropriada para as instâncias do GitHub Enterprise Server (consulte Suporte SARIF para a varredura de código para versões SARIF com suporte da 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 pull requests, use refs/pull/1234/merge ou refs/pull/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).

`--no-wait-for-processing`

Por padrão, a CLI aguardará que o GitHub processe o arquivo SARIF por até 2 minutos, retornando um código de saída diferente de zero se houver erros durante o processamento dos resultados da análise. Você pode personalizar o tempo que a CLI aguardará utilizando --wait-for-processing-timeout ou pode desabilitar o recurso utilizando --no-wait-for-processing.

`--wait-for-processing-timeout=<waitForProcessingTimeout>`

O tempo máximo em segundos que a CLI aguardará para que arquivo SARIF carregado seja processado pelo GitHub. O padrão é 120 segundos (2 minutos). Esta opção só é válida quando --wait-for-processing está habilitado.

`--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.

Confira também: Pontos de extremidade da API REST para varredura de código

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.)

`--common-caches=<dir>`

[Avançado] Controle a localização dos dados armazenados em cache no disco que persistirão entre várias execuções da CLI, como pacotes QL baixados e planos de consulta compilada. Se não for definido explicitamente, o padrão corresponde a um diretório intitulado .codeql no diretório inicial do usuário; que será criado se ainda não existir.

Disponível desde v2.15.2.