Skip to main content

Ejecutarel escaneo de código de CodeQL en un contenedor

Puedes ejecutar el escaneo de código en un contenedor si garantizas que todos los procesos se ejecutan en el mismo contenedor.

El Escaneo de código se encuentra disponible para repositorios que pertenecen a organizaciones de GitHub Enterprise Server. Esta característica requiere una licencia para la GitHub Advanced Security. Para obtener más información, consulta "Productos de GitHub".

Acerca del escaneo de código con una compilación en contenedor

Si estás configurando el escaneo de código para un lenguaje compilado, y estás compilando el código en un ambiente contenido, el análisis podría fallar con el mensaje de error "No source code was seen during the build". Esto indica que CodeQL no fue capaz de monitorear tu código mientras se compilaba.

Debes ejecutar a CodeQL dentro del mismo contenedor en el que compilaste tu código. Esto aplica a cuando utilizas el CodeQL CLI o GitHub Actions. Para el CodeQL CLI , consulta la sección "Instalar el CodeQL CLI en tu sistema de IC" para obtener más información. Si estás utilizando GitHub Actions, configura tu flujo de trabajo para ejecutar todas las acciones en el mismo contenedor. Para obtener más información, consulta la sección "Ejemplo de flujo de trabajo".

Dependencias

Es posible que tengas alguna dificultad para ejecutar el escaneo de código si el contenedor que estás utilizando carece de ciertas dependencias (Por ejemplo, Git debe instalarse y agregarse a la variable PATH). If you encounter dependency issues, review the list of software typically included on GitHub's runner images. Para obtener más información, consulta los archivos readme específicos de la versión en estas ubicaciones:

Ejemplo de flujo de trabajo

Nota: Este artículo describe las características disponibles con la versión de la acción de CodeQL y el paquete asociado del CLI de CodeQL que se incluye en el lanzamiento inicial de esta versión de GitHub Enterprise Server. Si tu empresa utiliza una versión más reciente de la acción de CodeQL, consulta el artículo de Nube de GitHub Enterprise para obtener más información sobre las características más recientes. Para obtener más información sobre cómo utilizar la última versión, consulta la sección "Configurar el escaneo de código para tu aplicativo".

Este flujo de trabajo de muestra utiliza GitHub Actions para ejecutar un análisis de CodeQL en un ambiente contenido. El valor de container.image identifica el contenedor que se debe utilizar. En este ejemplo, se le llama a la imagen codeql-container, con una etiqueta de f0f91db. Para obtener más información, consulta la sección "Sintaxis de flujo de trabajo para GitHub Actions".

name: "CodeQL"

on: 
  push:
    branches: [main]
  pull_request:
    branches: [main]
  schedule:
    - cron: '15 5 * * 3'

jobs:
  analyze:
    name: Analyze
    runs-on: ubuntu-latest
    permissions:
      security-events: write
      actions: read

    strategy:
      fail-fast: false
      matrix:
        language: [java]

    # Specify the container in which actions will run
    container:
      image: codeql-container:f0f91db

    steps:
      - name: Checkout repository
        uses: actions/checkout@v2
      - name: Initialize CodeQL
        uses: github/codeql-action/init@v1
        with:
          languages: ${{ matrix.language }}
      - name: Build
        run: |
          ./configure
          make
      - name: Perform CodeQL Analysis
        uses: github/codeql-action/analyze@v1