Cómo descargar un informe PDF de SonarQube desde Jira: guía paso a paso

Requisitos previos

Antes de descargar un informe PDF de SonarQube desde Jira, comprueba que cumples estos requisitos:

1 - Comprobar que se tiene instalada la app SonarQube Connector for Jira

La aplicación debe estar instalada en tu instancia de Jira Cloud. Sigue este proceso para instalar la app oficial:

• Accede a tu instancia de Jira como administrador.
• Ve al menú de Administración y luego Marketplace apps.
• Haz clic en Encontrar nuevas apps (Explore apps).
• En el buscador, escribe "SonarQube Connector for Jira" y selecciona la app.
• Elige Try free (probar gratis) o Buy now (comprar) y selecciona la instancia donde quieres hacer la instalación.
• También puedes descargar la app directamente desde el Atlassian Marketplace.

2 - Configurar la conexión con SonarQube

Lo siguiente que tienes que configurar es la conexión con SonarQube Server o SonarQube Cloud y las credenciales correspondientes. Para realizar esta configuración puedes seguir estos pasos:

• Accede a tu instancia de Jira, dirígete a Ajustes y selecciona Marketplace apps.
• En la barra lateral izquierda de Jira, busca en el listado de apps la opción de Global Configuration en SonarQube Connector for Jira. Aquí te dejamos una imagen para que puedas encontrarla.
• En la página que se abre, añade la URL de tu servidor SonarQube o credenciales para SonarQube Cloud.
• Introduce tu token de acceso (personal access token) de SonarQube para autenticar la conexión.

3 - Vincular los proyectos

El espacio de Jira donde quieras utilizar el SonarQube Connector for Jira debe estar vinculado al menos a un proyecto de SonarQube para que muestre la información. Para realizar esta configuración puedes seguir los siguientes pasos.

• En la barra lateral izquierda de Jira, dirígete al espacio donde quieras que aparezca la información del SonarQube Connector for Jira.
• Una vez accedas a los ajustes, dirígete a la barra lateral izquierda, selecciona Apps y haz clic en SonarQube.
• En la sección Connection settings podrás mantener la instancia de SonarQube de la configuración general o configurar una nueva instancia seleccionando o deseleccionando la casilla de "Check this option if you want to override global connection configuration".
• En la sección Project Settings, introduce la clave del proyecto de SonarQube del que quieres obtener la información. Una vez añadida, haz clic en el botón Guardar.
• Una vez completada la configuración, accede a la pestaña SonarQube de tu espacio de Jira para consultar la información del proyecto vinculado.

Cómo generar y descargar el informe PDF paso a paso

Sigue estos pasos desde tu espacio de Jira para descargar los informes de SonarQube.

1. Abre el proyecto de Jira

Accede a la pestaña de SonarQube de tu proyecto de Jira.

2. Accede al panel de SonarQube Connector

Desde esta pestaña puedes descargar un informe general de tipo Overview, que incluye las principales métricas de calidad del código de tu proyecto. Para generar el PDF, haz clic en el botón Download.

3. Descarga informes específicos de seguridad

Si quieres descargar informes en PDF específicos de seguridad, simplemente tienes que deslizarte hasta abajo, dentro de la pestaña de SonarQube y dirigirte a la sección de Security Reports.

Aquí tienes un listado de todos los informes disponibles para su descarga en PDF:

• CWE Top 25: informe de seguridad que identifica las debilidades de software más peligrosas presentes en el código, tomando como referencia el listado CWE Top 25. Ayuda a detectar y priorizar problemas que pueden comprometer la seguridad de una aplicación.
• OWASP Top 10: informe que permite analizar las vulnerabilidades del proyecto relacionadas con los diez principales riesgos de seguridad en aplicaciones web definidos por OWASP.
• OWASP ASVS: informe de evaluación de seguridad basado en el estándar OWASP Application Security Verification Standard (ASVS), que ayuda a revisar los requisitos y controles de seguridad de las aplicaciones.
• ISO 5055: informe de calidad y seguridad del código basado en el estándar ISO/IEC 5055, que permite evaluar debilidades del software relacionadas con la seguridad, fiabilidad, rendimiento y mantenibilidad.

4. Revisa el informe descargado

Abre el PDF para comprobar los datos y compartirlos con las personas que necesiten consultar el estado de calidad o seguridad del proyecto.

Cómo personalizar el logotipo del informe PDF

Otra de las funcionalidades del SonarQube Connector for Jira es que te permite configurar el logotipo corporativo que aparece en el pie de página de los informes. Puedes realizar esta configuración de forma global para aplicarla a los informes de todos los proyectos o configurarla individualmente para cada espacio.

1 - Configuración global para todos los informes

• En Jira, dirígete a Ajustes y selecciona Marketplace Apps.
• En la barra lateral izquierda, selecciona Configuración global de SonarQube Connector for Jira
• Desplázate hasta la sección PDF Report Settings, al final de la página, e introduce la URL del logotipo que quieres mostrar en el pie de página de los informes.

2 - Configurar el logotipo de los informes de un espacio específico

• Dirígete a la barra lateral izquierda, selecciona los tres puntos del espacio que quieras configurar y selecciona Ajustes del proyecto.
• En la barra lateral izquierda, selecciona Apps y SonarQube.
• En la pestaña PDF, activa la casilla Override Global PDF Config e introduce la URL de la imagen del logotipo que quieres mostrar en el pie de página de los informes de ese espacio.

Para modificar estos ajustes pueden ser necesarios permisos de administración.