es.davy.ai

Preguntas y respuestas de programación confiables

¿Tienes una pregunta?

Si tienes alguna pregunta, puedes hacerla a continuación o ingresar lo que estás buscando.

Generar y alojar la documentación de dbt en Netlify.

Tengo un proyecto de dbt rastreado en Github y me gustaría alojar la documentación en Netlify. Me preguntaba si es posible definir una Acción de Github que genere la documentación (dbt docs generate) al hacer push a la rama principal y luego despliegue la documentación en Netlify. Si es posible, ¿cuál sería la mejor manera de lograr esto?

Tags:  ,

Answer

  1. Avatar for davy.ai

    Sí, es posible definir una Acción de Github que genere la documentación para tu proyecto de dbt al realizar un push a la rama principal (master) y la despliegue en Netlify. La mejor manera de lograr esto sería utilizando los siguientes pasos:

    1. Configura tu cuenta de Netlify y crea un nuevo sitio.
    2. Conecta tu cuenta de Github con Netlify autorizando a Netlify en la configuración de Integraciones y Servicios de Github.

    3. Agrega un archivo netlify.toml en la raíz de tu proyecto de dbt, el cual especifica el comando de construcción (build) y el directorio de salida para tu documentación. Por ejemplo:

      [build]
       command = "dbt docs generate"
       publish = "target/docs"
      

    4. Crea una Acción de Github que realice los siguientes pasos:

      a. Al realizar un push a la rama principal (master), ejecuta el comando dbt docs generate para construir la documentación.

      b. Utiliza la CLI de Netlify para desplegar la documentación en tu sitio de Netlify.

      Por ejemplo:

      name: Desplegar en Netlify
      
      on:
       push:
         branches:
           - master
      
      jobs:
       construir-y-desplegar:
         runs-on: ubuntu-latest
      
         steps:
         - uses: actions/checkout@v2
      
         - name: Configurar Python
           uses: actions/setup-python@v2
           with:
             python-version: 3.x.x
      
         - name: Instalar dependencias
           run: pip install dbt netlify-cli
      
         - name: Construir y desplegar en Netlify
           run: |
             dbt docs generate
             netlify deploy --prod --dir=target/docs
      
    5. Guarda y realiza un commit del archivo de Acción de Github en el directorio .github/workflows de tu proyecto de Github.
    6. Prueba la Acción de Github haciendo push a los cambios en la rama principal (master) de tu proyecto de dbt y verifica que la documentación se genere y se despliegue en tu sitio de Netlify.

    Una vez que esto esté configurado, cualquier cambio que realices en la rama principal (master) de tu proyecto de dbt activará automáticamente la construcción y el despliegue de tu documentación en tu sitio de Netlify.

Comments are closed.