Ejecutarel escaneo de código de CodeQL en un contenedor

Puedes ejecutar el code scanning en un contenedor si garantizas que todos los procesos se ejecutan en el mismo contenedor.

¿Quién puede utilizar esta característica?

Repositorios propiedad de la organización con GitHub Advanced Security habilitado

En este artículo

Acerca del code scanning con una compilación en contenedor

Si estás configurando el code scanning para un lenguaje compilado y estás compilando el código en un entorno contenedorizado, el análisis podría dar error con el mensaje de error "No se vio código fuente durante la compilación". 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 se aplica si usas la CodeQL CLI o GitHub Actions. En el caso de CodeQL CLI, consulta "Utilizar el análisis de código de CodeQL con tu sistema de IC existente" para 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, vea "Flujo de trabajo de ejemplo".

Note

La CodeQL CLI no es compatible actualmente con distribuciones de Linux que no sean glibc, como Alpine Linux (basado en musl).

Dependencias para CodeQL code scanning

Es posible que tengas alguna dificultad para ejecutar el code scanning si el contenedor que estás utilizando carece de ciertas dependencias (Por ejemplo, Git debe instalarse y agregarse a la variable PATH). Si te encuentras con algún problema en las dependencias, revisa la lista de software que habitualmente se incluye en las imágenes de ejecutores de GitHub. Para obtener más información, vea los archivos readme específicos de la versión en estas ubicaciones:

Flujo de trabajo de ejemplo

Nota: En este artículo se describen las características disponibles con la versión de la acción CodeQL y el paquete CodeQL CLI asociado que se incluyen en la versión inicial de esta versión de GitHub Enterprise Server. Si en la empresa se usa una versión más reciente de la acción CodeQL, consulta la versión de GitHub Enterprise Cloud de este artículo para obtener información sobre las características más recientes. Para obtener información sobre el uso de la última versión, consulta "Configuración la digitalización de código para el dispositivo."

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 va a usar. En este ejemplo, la imagen se denomina codeql-container, con una etiqueta de f0f91db. Para obtener más información, vea «Sintaxis del flujo de trabajo para Acciones de GitHub».

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@v4
      - name: Initialize CodeQL
        uses: github/codeql-action/init@v2
        with:
          languages: ${{ matrix.language }}
      - name: Build
        run: |
          ./configure
          make
      - name: Perform CodeQL Analysis
        uses: github/codeql-action/analyze@v2