Establece la configuración del control de versión del proyecto

En esta página, se describe cómo configurar los elementos de tu proyecto a fin de integrarlos con Git para el control de versión.

Configuración de proyecto

Debes ser administrador de Looker para cambiar las opciones de la página Configuración del proyecto. Los desarrolladores de Looker que no son administradores pueden ver la página Configuración del proyecto, pero no pueden cambiar las opciones allí.

La página Configuración del proyecto contiene opciones de configuración para tu proyecto. Para ver esta página, abre tu proyecto y selecciona el ícono de configuración en el menú del ícono del IDE de Looker.

Desde aquí, puedes acceder a tres secciones:

Configuración

En la pestaña Configuración de la página Configuración del proyecto, puedes establecer la siguiente configuración:

  • Nombre: Es el nombre de tu proyecto. Para cambiar el nombre de tu proyecto, edita el texto y haz clic en el botón Save Project Configuration. Consulta la página de documentación Accede y edita la información del proyecto para obtener más detalles.

  • Git Production Branch Name: Especifica el nombre de la rama de Git que se usará como destino de combinación para las ramas de desarrollo de tu proyecto. La rama de Git debe existir en tu repositorio de Git. Consulta la sección Nombre de la rama de producción de Git de esta página para obtener más información.

  • Calidad del código: Determina si se requiere que los desarrolladores ejecuten correctamente el Validador de LookML en el proyecto antes de confirmar los cambios. La calidad del código tiene las siguientes opciones:

    • Exigir que se corrijan los errores y las advertencias antes de confirmar: Los desarrolladores de Looker pueden confirmar los cambios solo después de ejecutar correctamente el validador de LookML y resolver todos los errores y las advertencias. Esta es la configuración recomendada.
    • Solo exigir corregir los errores antes de confirmar: Los desarrolladores de Looker pueden confirmar los cambios solo después de ejecutar correctamente el validador de LookML y resolver todos los errores. Los desarrolladores pueden confirmar los cambios cuando existen advertencias. Aunque no se recomienda, esta opción puede ser útil, por ejemplo, si se agregan advertencias nuevas al funcionamiento de LookML en funcionamiento después de una actualización de Looker.
    • Permitir la confirmación de código dañado: Los desarrolladores de Looker pueden confirmar los cambios sin ejecutar el validador de LookML y sin importar si existen errores o advertencias en LookML. No se recomienda esta opción, ya que puede provocar que LookML no funcione o que produzca resultados erróneos.

  • Exigir que se aprueben las pruebas de datos antes de implementar este proyecto en producción: Si el proyecto de LookML tiene uno o más parámetros test, esta opción requiere que los desarrolladores ejecuten las pruebas de datos antes de implementar los cambios. Si se superan las pruebas de datos, el IDE le permitirá al desarrollador implementar cambios en la producción. Consulta la página de documentación del parámetro test si necesitas información para configurar las pruebas de datos en tu proyecto de LookML. Consulta la página de documentación Implementa y usa el control de versión para obtener información sobre cómo ejecutar pruebas de datos en tu proyecto. De forma predeterminada, la opción Exigir que las pruebas de datos se aprueben antes de implementar este proyecto en producción está habilitada para los proyectos nuevos de LookML.

  • Integración con Git: Especifica los niveles de integración con tu proveedor de Git. Consulta Opciones de integración de Git para obtener más detalles.

  • Habilitar el modo de implementación avanzada: Es un parámetro de configuración que, cuando se habilita, permite a los usuarios implementar cualquier SHA, etiqueta o rama en producción. Consulta la página de documentación del Modo de implementación avanzada para obtener más información sobre cómo usar el control de versión con el Modo de implementación avanzado habilitado.

  • Secreto de implementación de webhook: Configura la autenticación para implementar cambios en producción en tu instancia de Looker. Consulta la página de documentación Configura el secreto de implementación de webhook para obtener más detalles.

  • Restablecer conexión de Git: Este botón abre la ventana Configurar Git, en la que puedes actualizar la configuración de conexión de tu repositorio de Git.

    Si restableces tu conexión de Git, se conservará el historial de Git de la rama principal. También conservará el historial de la rama personal de cada desarrollador de Looker una vez que sincronice su Modo de desarrollador. Si deseas conservar el historial de todas las ramas, consulta la página de prácticas recomendadas para migrar a un repositorio de Git nuevo.

  • Borrar proyecto: Este botón borra el proyecto, lo que quita todo LookML del proyecto en todos los entornos de desarrollo y producción de tu instancia de Looker.

  • Resumen de Git: En esta sección, se muestra la configuración de Git del proyecto y la información de la rama de Git del usuario actual.

Nombre de la rama de producción de Git

Con la integración predeterminada de Looker en Git, todos los desarrolladores de Looker combinan sus cambios en una rama llamada main. Puedes usar el campo Git Production Branch Name para especificar qué rama de tu repositorio de Git debe usar Looker como la rama objetivo con la que se combinan las ramas de tus desarrolladores de Looker. Consulta la página de documentación Implementa y usa el control de versión para conocer el flujo de trabajo de Git predeterminado y otras opciones de implementaciones avanzadas de Git.

Para los proyectos existentes, considera hacer lo siguiente antes de cambiar el nombre de la rama de producción de Git:

  • Pedirles a todos los desarrolladores del proyecto de Looker que confirmen sus cambios y combinar sus ramas con la rama de producción existente, y que, luego, pausen su trabajo hasta que se actualice el nombre de la rama de producción de Git y se guarde en la configuración del proyecto de Looker.
  • Si tu proyecto usa solicitudes de extracción integradas, finaliza y combina cualquier solicitud de extracción abierta, según corresponda.
  • Realiza las preparaciones necesarias en el lado del proveedor de Git, como crear una rama nueva en tu repositorio, cambiar el nombre de la rama de Git predeterminada existente o las acciones que sean necesarias para preparar la rama, de modo que Looker pueda usarla como rama de destino para la combinación. Como mínimo, debes verificar que la rama que quieras usar sea una rama existente en tu repositorio de Git.

Sigue estos pasos para cambiar la rama de Git que usa tu proyecto como destino de combinación para las ramas de desarrollo:

  1. Selecciona el ícono Settings en el menú del ícono del IDE de Looker para mostrar la página Project Settings. La pestaña Configuración se abrirá de forma predeterminada.
  2. En el campo Git Production Branch Name, ingresa el nombre de la rama de Git que quieres usar como rama de producción para tu proyecto de Looker.
  3. Haz clic en el botón Save Project Configuration para guardar los cambios.

Importar credenciales

En la sección Importar credenciales, puedes administrar las credenciales de autenticación para repositorios remotos privados. Consulta la página de documentación Cómo importar archivos de otros proyectos para obtener más información.

Administración de ramas

En la pestaña Branch Management de la página Projects Settings, puedes ver todas las ramas de Git asociadas con el proyecto. Consulta la página de documentación Implementa y usa el control de versión para obtener más detalles.

Opciones de integración de Git

Una vez que configures tu conexión de Git, Looker usará tu proveedor de Git para administrar tus archivos fuente de LookML, como se describe en la página de documentación Implementa y usa el control de versión.

Si eres administrador de Looker, puedes configurar opciones adicionales para la integración de Looker en Git con las opciones de Git Integration en la pestaña Configuration de la página Project Settings:

  • Desactivado: Looker no mostrará ningún vínculo externo a la interfaz de tu proveedor de Git.
  • Mostrar vínculos: Looker proporcionará vínculos externos a la interfaz de tu proveedor de Git para que los desarrolladores puedan ver el proyecto en la interfaz del proveedor de Git. Looker también proporcionará vínculos para cada archivo de proyecto para que tus desarrolladores puedan ver el historial del archivo y la información de culpabilización de Git en la interfaz de tu proveedor de Git. Para obtener información sobre los vínculos, consulta la sección Cómo integrar vínculos externos a tu proveedor de Git.
  • Solicitudes de extracción recomendadas: Además de proporcionar vínculos externos a la interfaz de tu proveedor de Git, Looker les dará a los desarrolladores la opción de enviar una solicitud de extracción para que otro desarrollador pueda aprobar los cambios antes de agregarlos al proyecto. Consulta la sección Integra solicitudes de extracción para tu proyecto si deseas obtener información sobre cómo configurar esta opción.
  • Solicitudes de extracción requeridas: Es lo mismo que Solicitudes de extracción recomendadas, excepto que los desarrolladores de LookML deben abrir una solicitud de extracción para enviar cambios al proyecto. Consulta la sección Integra solicitudes de extracción para tu proyecto si deseas obtener información sobre cómo configurar esta opción.

Para guardar la configuración de integración de Git, haz clic en Save Project Configuration en la sección Deployment.

Si habilitaste alguna de las opciones adicionales de integración de Git (Mostrar vínculos, Solicitudes de extracción recomendadas o Solicitudes de extracción requeridas), Looker proporciona vínculos externos a la interfaz de tu proveedor de Git. Estos vínculos externos abren una pestaña nueva del navegador que dirige al sitio de tu proveedor de Git.

Para ver estos vínculos externos, tus desarrolladores deben tener una cuenta de tu proveedor de Git y deben tener acceso al repositorio de Git del proyecto.

En el menú de tres puntos File Options de cada uno de tus archivos de LookML, Looker proporciona vínculos al sitio de tu proveedor de Git para ver el archivo, ver la información de culpas a Git del archivo y ver el historial de confirmaciones del archivo.

En el panel Git Actions, también puedes usar la opción View Project on <Git provider> para abrir los archivos de tu proyecto en el sitio de tu proveedor de Git.

Integra solicitudes de extracción para tu proyecto

Con la integración predeterminada de Looker Git, los desarrolladores de Looker confirman los cambios en su rama de desarrollo y, luego, la fusionan en la rama de producción. Luego, cuando realices una implementación en el entorno de Looker, Looker usará la confirmación más reciente en la rama production. Consulta la página de documentación Implementa y usa el control de versión para conocer el flujo de trabajo de Git predeterminado y otras opciones de implementaciones avanzadas de Git.

En lugar de permitir que los desarrolladores de Looker fusionen su rama de desarrollo con la rama de producción de Looker, puedes configurar tu proyecto con las opciones Solicitudes de extracción recomendadas o Solicitudes de extracción requeridas:

  • Solicitudes de extracción recomendadas: Después de que un desarrollador confirma los cambios en su rama de desarrollo, el botón de Git en el IDE de Looker le indica al desarrollador que abra una solicitud de extracción para combinar su rama de desarrollo con la rama de producción. Luego, el desarrollador puede abrir una solicitud de extracción para que otros desarrolladores de Looker la revisen y aprueben desde la interfaz web del proveedor de Git. O bien, el desarrollador puede usar la opción Deploy to Production (Implementar en producción) del panel de acciones de Git (Git Actions) para omitir la creación de una solicitud de extracción y, luego, implementar los cambios en producción. (La opción Implementar en producción no está disponible si el proyecto está habilitado con el modo de implementación avanzado).
  • Se requieren solicitudes de extracción: Después de que un desarrollador confirma los cambios en su rama de desarrollo, el botón de Git en el IDE de Looker le indica al desarrollador que abra una solicitud de extracción. El desarrollador debe abrir una solicitud de extracción para combinar su rama de desarrollo con la de producción. Luego, otros desarrolladores de Looker pueden revisar y aprobar la solicitud de extracción desde la interfaz web del proveedor de Git.

Looker admite la integración de solicitud de extracción para los siguientes proveedores de Git:

  • GitHub
  • GitLab
  • Bitbucket Cloud
  • Bitbucket Server (anteriormente “Stash”)

Estas son algunas notas adicionales sobre el uso de las solicitudes de extracción con Looker:

  • Para abrir las solicitudes de extracción, tus desarrolladores deben tener una cuenta con tu proveedor de Git y tener acceso al repositorio de Git del proyecto.

  • Si la función Lista de IP permitidas está habilitada en tu instancia, para integrar las solicitudes de extracción en cualquier proyecto de LookML, deberás agregar a la lista de entidades permitidas el rango de direcciones IP desde las que tu proveedor de Git realiza solicitudes salientes. Por ejemplo, las direcciones IP actuales de GitHub se enumeran en el registro de cambios de GitHub. Las IP están sujetas a cambios y serán diferentes para otros proveedores de Git.

  • Si habilitaste el modo de implementación avanzada, no es necesario configurar un webhook en la sección Configura tu proyecto con solicitudes de extracción integradas, ya que este modo separa las funciones de implementación y combinación.

  • Si un desarrollador de Looker emitió una solicitud de extracción que deseas revertir, consulta la publicación de Comunidad Cómo revertir las solicitudes de extracción de Looker a través de GitHub para obtener más información.

  • Las solicitudes de extracción de Git permiten usar una instancia de etapa de pruebas para Looker, de modo que puedas tener una instancia de etapa de pruebas y otra de producción con las solicitudes de extracción habilitadas en la instancia de etapa de pruebas. Todo el desarrollo y la revisión de código se pueden realizar en el entorno de etapa de pruebas y el código revisado se puede implementar en la instancia de producción. Para configurar esto, consulta la publicación de Comunidad Flujo de trabajo de Git con un repositorio en varias instancias: desarrollo, etapa de pruebas y producción.

  • Looker combina los cambios de una rama de desarrollador de Looker en la rama de producción con el método de combinación de combinación. Cuando uses la interfaz de tu proveedor de Git, asegúrate de que los desarrolladores no usen la combinación de squash ni la combinación de rebase. Consulta la sección Opciones de combinación en la interfaz del proveedor de Git para obtener más información.

Configura tu proyecto con solicitudes de extracción integradas

Para configurar tu proyecto de Looker con solicitudes de extracción de Git, haz lo siguiente:

  1. En tu proyecto, selecciona Configuración del proyecto en el menú del ícono del IDE de Looker.
  2. En la sección Git Integration de la pestaña Configuration, selecciona Pull requests Recommended o Pull requests Required.
  3. De manera opcional, si deseas configurar un webhook de implementación automática en la interfaz de tu proveedor de Git, copia la información del webhook y pégala en un archivo de texto. Si tu proyecto está configurado para usar el modo de implementación avanzada, puedes omitir este paso. También puedes decidir más tarde y volver a la configuración del proyecto para obtener la información del webhook.
  4. De manera opcional, puedes configurar un secreto de implementación de webhook para autenticar un webhook de implementación automática desde tu proveedor de Git o un webhook en modo de implementación avanzada. Para crear un secreto de webhook, haz clic en Configurar secreto de webhook. Copia el secreto de implementación y pégalo en un archivo de texto para usarlo cuando agregues el webhook a la interfaz de tu proveedor de Git. También puedes decidir más adelante y volver a la configuración del proyecto para agregar un secreto de implementación. Consulta la página de documentación Configura el secreto de implementación de webhook para obtener más información.
  5. Haz clic en Save Project Configuration.

Ahora, cada vez que un desarrollador de Looker confirme cambios en tu proyecto, el IDE de Looker mostrará el botón Open Pull Request. El botón abre una nueva pestaña del navegador directamente en la nueva página de solicitud de extracción en el sitio web de tu proveedor de Git.

Una vez que hayas configurado tu proyecto de Looker para usar solicitudes de extracción, realiza una de las siguientes acciones a fin de configurar la forma en que se implementan las confirmaciones en tu entorno de producción:

  • Para implementar automáticamente las últimas confirmaciones combinadas con tu rama production, usa la interfaz de tu proveedor de Git para agregar un webhook, como se describe en la siguiente sección en esta página.
  • Para especificar manualmente qué ramas o confirmaciones se deben implementar, habilita el modo de implementación avanzada. Consulta la página de documentación sobre el modo de implementación avanzado para obtener información sobre cómo habilitar y administrar este modo.

Agrega un webhook a tu proveedor de Git

En el caso de los proyectos de Looker habilitados para las solicitudes de extracción, puedes configurar un webhook de implementación en la interfaz de tu proveedor de Git. Este webhook activará que Looker implemente la confirmación más reciente desde la rama production cada vez que fusiones una solicitud de extracción en la interfaz del proveedor de Git.

En la mayoría de los casos, no querrás configurar un webhook de implementación automática si tu proyecto está configurado para usar el modo de implementación avanzada. El modo de implementación avanzada te permite seleccionar la confirmación y la rama que deseas implementar, por lo que, en la mayoría de los casos, configurar un webhook de implementación automática anularía las funciones del modo de implementación avanzada.

Para agregar un webhook de implementación automática a la interfaz de tu proveedor de Git, primero ve a la configuración del proyecto en Looker. Para ello, haz clic en el ícono de Configuración del menú del ícono del IDE de Looker del proyecto. A continuación, copia el webhook de la sección Integración con Git.

El webhook toma el formato <instance_url>/webhooks/projects/<project_name>/deploy.

Reemplaza <instance_url> por la URL de tu instancia de Looker. Por ejemplo, si la URL de tu instancia de Looker es example.looker.com y el nombre de tu proyecto es e_faa, el webhook se verá de la siguiente manera:

https://example.looker.com/webhooks/projects/e_faa/deploy

Desde la configuración del proyecto de Looker, también puedes obtener un secreto de implementación de webhook para autenticar las integraciones de Git de tu proyecto con tu proveedor de Git. Consulta la página de documentación Configura el secreto de implementación de webhook para obtener más información.

Una vez que tengas la URL de webhook y el secreto de webhook de implementación, puedes ingresarlos en la interfaz de tu proveedor de Git. Si tu proveedor de Git es GitHub, sigue estos pasos:

  1. Navega hasta la configuración del repositorio de tu proyecto en el repositorio de GitHub.
  2. En la configuración del repositorio, haz clic en Webhooks. Haz clic en Add Webhook para abrir la ventana Add Webhook.
  3. En el campo URL de carga útil, pega la información del webhook que copiaste de la sección Integración con Git en Looker.
  4. De forma opcional, puedes agregar un secreto de implementación de webhook que autentique las integraciones de Git de tu proyecto con tu proveedor de Git. Copia el secreto de implementación de la configuración de tu proyecto de LookML y pégalo en el campo Secreto, en la interfaz del proveedor de Git. Consulta la página de documentación Configura el secreto de implementación de webhook para obtener más información.
  5. Selecciona la opción Solo el evento push en el campo ¿Qué eventos quieres que activen este webhook?
  6. Haz clic en Add webhook (Agregar webhook).

Usa un webhook de implementación para extraer datos desde un repositorio de Git remoto

Cuando las solicitudes de extracción están habilitadas para tu proyecto de LookML y los webhooks de implementación no están automatizados, es posible que, de vez en cuando, descubras que el LookML que ves en el modo de producción de Looker no coincide con el de LookML de la rama principal de tu repositorio de Git. Esto puede ocurrir en las siguientes situaciones:

  • Cuando las solicitudes de extracción están habilitadas para el repositorio
  • Cuando se editó LookML fuera del entorno de desarrollo de Looker, por ejemplo:
    • En el repositorio de Git
    • En otra instancia de Looker, como una instancia de etapa de pruebas

Puedes sincronizar la rama de producción de Looker con la rama principal del repositorio a través de un webhook de implementación:

  1. Abre una nueva pestaña del navegador y escribe la siguiente URL (reemplaza <instance_url> por la URL de tu instancia de Looker y <project_name> por el nombre de tu proyecto de LookML):

    <instance_url>/webhooks/projects/<project name>/deploy

  2. Después de ejecutar la URL de webhook de implementación, una página web en blanco mostrará un mensaje de éxito similar al siguiente:

    {"operations":[{"error":false,"error_code":0,"command":"Checkout Branch #\u003cLooker::GitBranch:0x5798672b\u003e","node_id":728,"results":["Success"]},{"error":false,"error_code":0,"command":"jgit revert_repo","node_id":728,"results":["Success"]}],"new_head":"05f772af48709fc2799fefe408e3fdd895a63284","old_head":"77412cad9fd7ed3eed1627afa201fdf7dcb97dd1"}

Ahora el modo de producción en Looker se actualizó para reflejar tu rama principal remota de Git. Tu rama de desarrollador personal y las ramas compartidas no se verán afectadas.

Utiliza un repositorio de Git remoto para webhooks con secretos de implementación

Si tu proyecto de LookML también requiere un secreto de implementación de webhook para enviar cambios de tu rama principal a tu rama de producción, recibirás uno de los siguientes errores cuando sincronices la rama production con la rama principal del repositorio con el método descrito en la sección anterior Usa un webhook de implementación para extraer desde un repositorio remoto de Git:

{"error":"Uh oh! Something went wrong."}

Como alternativa, puedes hacer lo siguiente:

{"error":"Not found."}

En lugar de usar el webhook de implementación, puedes ejecutar el siguiente comando cURL en tu terminal con el secreto del webhook. Asegúrate de reemplazar los siguientes campos:

  • Reemplaza <instance_URL> por la URL de tu instancia de Looker.
  • Reemplaza <deploy_secret> por el secreto de implementación de tu proyecto.
  • Reemplaza <project_name> por el nombre de tu proyecto de LookML.
curl -i -X POST -H "X-Looker-Deploy-Secret:<deploy_secret>" https://<instance_url>/webhooks/projects/<project_name>/deploy

Por ejemplo, si sincronizas una rama production para el ecommerce_project en la instancia Brettcase con la rama principal del repositorio:

curl -i -X POST -H "X-Looker-Deploy-Secret:123123123secretgoeshere123123123" https://brettcase.looker.com/webhooks/projects/ecommerce_project/deploy

Opciones de combinación en la interfaz del proveedor de Git

Si tu proyecto de Looker está integrado en las solicitudes de extracción, tus desarrolladores usarán la interfaz de tu proveedor de Git para enviar solicitudes de extracción y combinar los cambios en la rama production.

Looker admite el método de confirmación de combinación para combinar cambios de una rama de desarrollo en tu rama de producción. Sin embargo, es posible que la interfaz de tu proveedor de Git muestre opciones adicionales para la combinación, como Aplastar y combinar o Cambiar la base y combinar.

Looker no admite la combinación de squash ni la combinación de reubicación, por lo que los desarrolladores deben evitar usar estas opciones. Si es posible, la práctica recomendada es inhabilitar estas opciones en tu repositorio. Para inhabilitar estas opciones en un repositorio de GitHub, sigue estos pasos:

  1. Dirígete a la pestaña Configuración para acceder a la configuración del repositorio de tu proyecto en GitHub.

    SUGERENCIA: Para los proyectos configurados con la integración de Git, puedes usar la opción View Project on Git en el menú de Git del proyecto en Looker.

  2. En la configuración de tu repositorio, haz clic en Opciones en el menú de navegación.

  3. Ve a la sección Botón Combinar y deja marcada solo la opción Permitir confirmaciones de combinación. Inhabilita las opciones Permitir la combinación de squash y Permitir la combinación de reubicación.

Una vez que inhabilites las opciones de combinación, no estarán disponibles en GitHub cuando tus desarrolladores fusionen una rama en el repositorio.