> [English](https://github.com/bakhirev/assayo) | __[Español](https://github.com/bakhirev/assayo/blob/main/documents/ES.md)__ | [中文](https://github.com/bakhirev/assayo/blob/main/documents/ZH.md) | [Français](https://github.com/bakhirev/assayo/blob/main/documents/FR.md) | [Deutsch](https://github.com/bakhirev/assayo/blob/main/documents/DE.md) | [Português](https://github.com/bakhirev/assayo/blob/main/documents/PT.md) | [日本語](https://github.com/bakhirev/assayo/blob/main/documents/JA.md) | [Русский](https://github.com/bakhirev/assayo/blob/main/documents/RU.md) > [Documentación básica](https://github.com/bakhirev/assayo/blob/main/documents/RU.md) en ruso. Es una traducción. Puede contener errores. Si usted es un hablante nativo, puede ayudar a mejorar esta traducción. ¡Gracias! # [Assayo](https://assayo.online/?ref=github&lang=es) Visualización y análisis de los datos de su repositorio git. ([demo](https://assayo.online/demo/?ref=github&lang=es&dump=./test.txt), [install](https://assayo.online/demo/?ref=github)). ##### 👨‍💻 El empleado puede evaluar el nuevo lugar de trabajo - El ritmo de trabajo; - El número de horas extras; - Las áreas de responsabilidad; - El volumen de características y errores; - El estilo de trabajo de los colegas; ##### ‍👨‍💼 El jefe puede evaluar a los empleados - Identificar a los ociosos; - Calcular el volumen de código; - Conocer la velocidad de trabajo; - Se han notado anomalías de comportamiento; - Ver el ritmo de trabajo por semanas; ##### 👑 El inversor puede evaluar el producto - El costo del producto; - El coste de las peculiaridades; - El tiempo de desarrollo; - La predicción del tiempo de mejoras; - La predicción del costo; ### Table of contents - [Cómo puedo rápidamente ver el número de commits?](#link-4) - [Cómo combinar a los autores?](#link-5) - [Cómo descargar los datos desde git?](#link-6) - [Para la visualización en línea](#link-7) - [Para ver sin conexión](#link-8) - [¿Cómo ver el informe?](#link-9) - [Online](#link-10) - [Offline](#link-11) - [Como recompilar el build de un informe?](#link-12) - [Como mirar el reporte de un grupo de microservicios?](#link-13) - [¿Cómo puedo personalizar la interfaz de usuario?](#link-14) - [¿Cómo firmar los commits?](#link-15) - [How to add checking for commit message?](#link-16) - [ Use file commit-msg](#link-17) - [ Use package pre-commit](#link-18) - [¿Cómo automatizar el recolección de datos?](#link-19) - [With backend](#link-20) - [Sin backend](#link-21) - [DevOps ](#link-22) - [Servidor público](#link-23) - [Servidor privado](#link-24) - [Actualización de la imagen Docker](#link-25) - [️ About application](#link-26) - [Architecture](#link-27) - [Los lanzamientos son aproximadamente una vez cada seis meses. Lo siguiente será:](#link-28) - [¿Cómo añadir o editar una traducción?](#link-29) - [Deseos, comentarios](#link-30) ### 🚀 Cómo puedo rápidamente ver el número de commits? En la carpeta raíz de su proyecto, ejecute: ``` git shortlog -s -n -e ``` ### ‍🎭 Cómo combinar a los autores? En la carpeta raíz de su proyecto debe crear un archivo `.mailmap`. Un ejemplo del contenido del archivo: ``` Alex B Alex B Alex B Alex B ``` Más información sobre el formato de este archivo se puede leer en [aquí](https://git-scm.com/docs/gitmailmap). ### 📤 Cómo descargar los datos desde git? #### Para la visualización en línea En el directorio raíz de su proyecto ejecutar: ``` git --no-pager log --raw --numstat --oneline --all --reverse --date=iso-strict --pretty=format:"%ad>%cN>%cE>%s" > log.txt ``` #### Para ver sin conexión ``` git --no-pager log --raw --numstat --oneline --all --reverse --date=iso-strict --pretty=format:"%ad>%cN>%cE>%s" | sed -e 's/\\/\\\\/g' | sed -e 's/`/"/g' | sed -e 's/^/report.push(\`/g' | sed 's/$/\`\);/g' | sed 's/\$/_/g' > log.txt ``` Git creará un archivo `log.txt`. contiene los datos para construir el informe. La diferencia entre los formatos en línea y fuera de línea está en la existencia de una envoltura para las cadenas. El formato fuera de línea se cargará como un archivo`js` si usted simplemente lo abrió. `/build/index.html` ### 📈 ¿Cómo ver el informe? #### Online - Ir a [sitio web](https://assayo.online/) - Pulse el botón [Demo](https://assayo.online/demo?ref=github&lang=es)» - Arrastrar y soltar archivo `log.txt` en la ventana del navegador #### Offline - Descargar este repositorio - Arrastrar y soltar archivo `log.txt` en la carpeta `/build` - Lanzar `/build/index.html` - O arrastrar una carpeta `/build` a su repositorio (donde se encuentra ' log.txt`). Puede cambiar el nombre. Por ejemplo `/build` contra `/report` En este caso, es importante que el archivo ' log.txt ' fue generado por el equipo para ver sin conexión. ### 🏭 Como recompilar el build de un informe? - Descargar este repositorio - Ejecutar `npm install` - Ejecutar `npm run build-local` - La nueva compilación estará en el directorio `/build` ### 🗃️ Como mirar el reporte de un grupo de microservicios? - Generar para cada microservicio el archivo `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` etc.) - Ver “Cómo ver el informe en línea?”. En el último paso, arrastrar todos los archivos al navegador. - Ver “Cómo ver informe fuera de línea?”. En el segundo paso, arrastrar los archivos de todos los microservicios al navegador (`log-1.txt`, `log-2.txt`, `log-3.txt` etc.) la carpeta informe (`/build`). ### 🎨 ¿Cómo puedo personalizar la interfaz de usuario? Puedes crear tu propio tema para la interfaz. Puedes cambiar: - **El título**. Puedes especificarlo en el parámetro de la URL ```title```. Por ejemplo: ```?title=You Company``` - **El tema visual**. Para esto, debes preparar un archivo CSS con los nuevos estilos y especificar su dirección en el parámetro de URL ```theme```. Por ejemplo: ```?theme=//company.com/some.css```. Puedes usar los nombres de clases como selectores. La mayoría de ellos no cambia con el lanzamiento de nuevas versiones. - **La lengua**. Puedes especificarla en el parámetro de la URL ```lang```. Por ejemplo: ```?lang=es``` ### 📝 ¿Cómo firmar los commits? Siga la práctica [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Por ejemplo: ``` JIRA-1234 feat(profile): Added avatar for user ``` - El número de la tarea en el gestor de tareas es `(JIRA-1234)` - tipo de trabajo `(feat, fix, style, refactor, test, doc etc.)` - ficha `(profile - La sección del sitio, la página o la nueva funcionalidad, en una palabra)` - ¿qué problema resolvieron? `(Added avatar for user)` ### 👮 How to add checking for commit message? #### Use file `commit-msg` 1. Create file `commit-msg` in folder `.git/hooks/` 2. Add this text in file: ``` #!/usr/bin/env bash if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)((\([a-z0-9_-]{1,}\)){0,})(:\s)([a-z]{1,})" "$1"; then echo "Need commit message like: JIRA-12 fix(profile): some text. Read Semantic Commit Messages" >&2 exit 1 fi ``` #### Use package [pre-commit](https://www.npmjs.com/package/pre-commit) 1. Add in file `package.json` property `commit-msg`: ``` ... "commit-msg": { "regex": "(JIRA-[0-9]{1,5})(\\s)(feat|fix|docs|style|refactor|test|chore)((\\([a-z0-9_-]{1,}\\)){0,})(:\\s)([a-z]{1,})", "error-message": "Need commit message like: JIRA-12 fix(profile): some text Read Semantic Commit Messages" }, ... ``` 2. Run command `npm install pre-commit` ### 📚 ¿Cómo automatizar el recolección de datos? #### With backend - use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler); #### Sin backend - clone del repositorio que desea; - copiar a la carpeta raíz `build`; - abridlo `build/index.html` añadir a favoritos; - agregue un icono de `build/assets/ci-cd.sh` a su carpeta de inicio automático (Windows); Cada vez que reinicie su computadora, el script actualizará la estadística de todos los datos que se hayan incorporado automáticamente a la rama principal. ### 🛠️ DevOps (CI/CD) #### Servidor público Puede publicar el archivo con los datos para generar el informe en una URL pública. Para visualizarlo, puede usar la interfaz web del sitio [assayo](https://assayo.online/). Simplemente indique la dirección donde están los datos en el parámetro URL ```dump```: ``` https://assayo.online/demo/?dump=//you_site.com/some/log.txt ``` #### Servidor privado - descargar [docker образ](https://hub.docker.com/r/bakhirev/assayo); - recogerlo en la red local; - Para ver los informes, use la interfaz web indicándole la dirección de los datos en el parámetro URL ```dump```: ``` http://assayo_url/?dump=//you_url/some/log.txt assayo_url - URL dirección del contenedor assayo, Él está escuchando el puerto 80; you_url - URL la dirección de su contenedor con registros git; ``` Por defecto, la imagen se ejecutará en la siguiente dirección ```http://127.0.0.1:80/```. Si no funciona, compruebe si tiene el puerto 80 disponible #### Actualización de la imagen Docker - eliminar métricas, alertas, compilaciones antiguas; - construir ```npm run build-local``` - montar la imagen ```docker build -t assayo .``` - comprobar visualmente la imagen ```docker run --name assayo -p 80:80 -d assayo```; - poner la etiqueta ```docker tag assayo bakhirev/assayo:latest```; - poner la imagen en Docker Hub ```docker push bakhirev/assayo:latest```; ### 🛠️ ️ About application #### 📐 Architecture 1. [Reports showcase UI](https://github.com/bakhirev/assayo-showcase) displays a list of available reports. Each report consists of a title, description, and a list of repositories. 2. [Crawler service](https://github.com/bakhirev/assayo-crawler) collects repository logs for the report. 3. [Log visualization UI](https://github.com/bakhirev/assayo) **(you here)** displays report. Needs a log file for work. #### 🈯 Los lanzamientos son aproximadamente una vez cada seis meses. Lo siguiente será: - más consejos y logros; - resultados del año / mes, impresión de informes; - localización e internacionalización; - análisis de archivos; - diferentes roles para estadísticas (ocultación de finanzas); - desarrollo de la parte de atrás, integraciones con otros sistemas; #### 🗺️ ¿Cómo añadir o editar una traducción? Puede agregar una nueva traducción o corregir la actual en la sección ```ts/translations/```. [Instrucciones](https://github.com/firstcontributions/first-contributions) #### 📧 Deseos, comentarios - telegramm [@bakhirev](https://t.me/bakhirev) (La forma preferencial de contacto) - [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru) - sitio web [https://assayo.online/](https://assayo.online/?ref=github&lang=es)