Solucionar problemas no fluxo de trabalho do CodeQL

Produzir registros detalhados para depuração

Para produzir a saída de log mais detalhada, você pode habilitar o log de depuração da etapa. Para obter mais informações, consulte "Habilitar o registro de depuração".

Ocorreu uma falha durante a criação automática para uma linguagem compilada

Se ocorrer uma falha na uma criação automática de código para uma linguagem compilada dentro de seu projeto, tente as seguintes etapas para a solução de problemas.

• Remova a etapa de autobuild do seu fluxo de trabalho de Varredura de código e adicione etapas de criação específicas. Para obter informações sobre a edição do fluxo de trabalho, consulte "Configurar Varredura de código". Para obter mais informações sobre a substituição da etapa autobuild, consulte "Configurar o fluxo de trabalho de CodeQL para linguagens compiladas."

• Se seu fluxo de trabalho não especificar explicitamente linguagens para analisar, CodeQL irá detectar implicitamente as linguagens compiladas na sua base de código. Nesta configuração, das linguagens compiladas de C/C++, C#, e Java, CodeQL analisa apenas a linguagem com mais arquivos-fonte. Edite o fluxo de trabalho e adicione uma matriz especificando as linaguagens que você deseja analisar. O fluxo de trabalho de análise do CodeQL padrão usa essa matriz.

  Os seguintes extratos de um fluxo de trabalho mostram como usar uma matriz dentro da estratégia de trabalho para especificar linguagens e, em seguida, fazer referência a cada linguagem dentro da etapa "Inicializar CodeQL:

  jobs:
    analyze:
      ...
      strategy:
        fail-fast: false
        matrix:
          language: ['csharp', 'cpp', 'javascript']
  
      steps:
      ...
        - name: Initialize CodeQL
          uses: github/codeql-action/init@v1
          with:
            languages: ${{ matrix.language }}
  

  Para obter mais informações sobre a edição do fluxo de trabalho, consulte "Configurar a varredura de código".

Nenhum código encontrado durante a criação

Se seu fluxo de trabalho falhar com um erro Nenhum código fonte foi visto durante a criação ou O processo '/opt/hostedtoolcache/CodeQL/0. .0-20200630/x64/codeql/codeql' falhou com o código de saída 32, isto indica que CodeQL não foi capaz de monitorar o seu código. Há várias explicações para essa falha:

1. O repositório pode não conter o código-fonte escrito em linguagens compatíveis por CodeQL. Verifique a lista de linguagens compatíveis e, se for esse o caso, remova o fluxo de trabalho de CodeQL. Para obter mais informações, consulte "Sobre digitalização de código com o CodeQL".

2. A detecção automática da linguagem identificou uma linguagem compatível, mas não há código analisável dessa linguagem no repositório. Um exemplo típico é quando nosso serviço de detecção de linguagem encontra um arquivo associado a uma determinada linguagem de programação, como um arquivo .h, or .gyp, mas nenhum código executável correspondente está presente no repositório. Para resolver o problema, você pode definir manualmente as linguagens que você deseja analisar atualizando a lista de linguagens na matriz de linguagem`. Por exemplo, a configuração a seguir analisará somente Go, e JavaScript.

     strategy:
       fail-fast: false
       matrix:
         # Override automatic language detection by changing the list below.
         # As opções compatíveis estão listadas em um comentário no fluxo de trabalho padrão.
         language: ['go', 'javascript']
   `

   Para obter mais informações, consulte a extração de fluxo de trabalho em "Criação automática para falhas de linguagem compilada" acima.

3. O seu fluxo de trabalho de Varredura de código está analisando uma linguagem compilada (C, C++, C#, ou Java), mas o código não foi compilado. Por padrão, o fluxo de trabalho da análise do CodeQL contém uma etapa autobuild. No entanto, esta etapa representa um melhor processo de esforço, e pode não ter sucesso na criação do seu código, dependendo do seu ambiente de criação específico. Também pode ocorrer uma falha na criação se você removeu a etapa de autobuild e não incluiu as etapas de criação manualmente. Para obter mais informações sobre a especificação de etapas de criação, consulte "Configurar o fluxo de trabalho do CodeQL para linguagens compiladas".

4. O seu fluxo de trabalho está analisando uma linguagem compilada (C, C++, C#, ou Java), mas partes de sua compilação são armazenadas em cache para melhorar o desempenho (é mais provável que ocorra com sistemas de criação como o Gradle ou Bazel). Uma vez que o CodeQL observa a atividade do compilador para entender os fluxos de dados em um repositório, CodeQL exige uma compilação completa para realizar a análise.

5. O seu fluxo de trabalho está analisando uma linguagem compilada (C, C++, C#, ou Java), mas a compilação não ocorre entre as etapas init e analisar no fluxo de trabalho. O CodeQL exige que a sua compilação aconteça entre essas duas etapas para observar a atividade do compilador e realizar a análise.

6. Seu código compilado (em C, C++, C#, ou Java) foi compilado com sucesso, mas o CodeQL não conseguiu detectar as chamadas do compilador. As causas mais comuns são:

   • Executar seu processo de criação em um contêiner separado para CodeQL. Para obter mais informações, consulte "Executar a varredura de código do CodeQL em um contêiner".
   • Criar usando um sistema de compilação distribuído externo � s Ações GitHub, usando um processo de daemon.
   • CodeQL não está ciente do compilador específico que você está usando.

   Para projetos de .NET Framework e para projetos C# que usam dotnet build ou msbuild, você deverá especificar /p:UseSharedCompilation=false na etapa de executar do seu fluxo de trabalho, ao criar o seu código.

   Por exemplo, a seguinte configuração para C# irá passar o sinalizador durante a primeira etapa de criação.

   - run: |
       dotnet build /p:UseSharedCompilation=false
   

   Se você encontrar outro problema com seu compilador específico ou configuração, entre em contato com your site administrator.

Executar somente durante um evento de agendamento`

Se sua análise ainda é muito lenta para ser executada durante eventos push` ou `pull_request`, você poderá acionar apenas a análise no evento `agendamento`. Para obter mais informações, consulte "[Eventos](/actions/learn-github-actions/introduction-to-github-actions#events)".

Aviso: 1 issue was detected with this workflow: git checkout HEAD^2 is no longer 
necessary. Please remove this step as Code Scanning recommends analyzing the merge 
commit for best results.

        with:
          # We must fetch at least the immediate parents so that if this is
          # a pull request then we can checkout the head.
          fetch-depth: 2

      # If this run was triggered by a pull request event, then checkout
      # the head of the pull request instead of the merge commit.
      - run: git checkout HEAD^2
        if: ${{ github.event_name == 'pull_request' }}

    steps:
      - name: Checkout repository
        uses: actions/checkout@v2

      # Initializes the CodeQL tools for scanning.
      - name: Initialize CodeQL
        uses: github/codeql-action/init@v1

      ...