> [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)__ # [Assayo](https://assayo.online/?ref=github&lang=ru) Визуализация и анализ данных вашего git-репозитория ([демо](https://assayo.online/demo/?ref=github&lang=ru&dump=./test.txt), [install](https://assayo.online/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo)). ##### 👨‍💻 Сотрудник может оценить новое место работы - темп работы; - количество переработок; - зоны ответственности; - объем фичей и багов; - стиль работы коллег; ##### ‍👨‍💼 Руководитель может оценить сотрудников - выявить бездельников; - прикинуть объём кода; - узнать скорость работы; - заметить аномалии поведения; - посмотреть динамику работы по неделям; ##### 👑 Инвестор может оценить продукт - стоимость продукта; - стоимость фичей; - время на разработку; - прогноз времени доработок; - прогноз стоимости; ### Содержание - [Как быстро посмотреть количество коммитов?](#link-4) - [Как объединить авторов?](#link-5) - [Как выгрузить данные из git?](#link-6) - [Для онлайн просмотра](#link-7) - [Для офлайн просмотра](#link-8) - [Если вы используете PowerShell в Windows](#link-9) - [Как посмотреть отчёт? ](#link-10) - [Онлайн](#link-11) - [Офлайн](#link-12) - [Как пересобрать файл отчёта из исходного кода?](#link-13) - [Как посмотреть отчёт по группе микросервисов?](#link-14) - [Как брендировать интерфейс?](#link-15) - [Как подписывать коммиты?](#link-16) - [Как добавить проверку текста коммита?](#link-17) - [Используя файл commit-msg](#link-18) - [Используя пакет pre-commit](#link-19) - [Как автоматизировать сбор данных?](#link-20) - [С бекендом](#link-21) - [Без бекенда](#link-22) - [DevOps ](#link-23) - [Публичный сервер](#link-24) - [Приватный сервер](#link-25) - [Обновление Docker-образа](#link-26) - [️ О приложении](#link-27) - [Архитектура](#link-28) - [Релизы, примерно, раз в полгода. Что дальше:](#link-29) - [Как добавить или отредактировать перевод?](#link-30) - [Пожелания, предложения, замечания](#link-31) ### 🚀 Как быстро посмотреть количество коммитов? В корневой директории вашего проекта выполнить: ``` git shortlog -s -n -e ``` ### ‍🎭 Как объединить авторов? В корневой директории вашего проекта нужно создать файл `.mailmap`. Пример содержания файла: ``` Alex B Alex B Alex B Alex B ``` Подробнее про формат этого файла можно прочитать [тут](https://git-scm.com/docs/gitmailmap). ### 📤 Как выгрузить данные из git? #### Для онлайн просмотра В корневой директории вашего проекта выполнить: ``` git --no-pager log --raw --numstat --oneline --all --reverse --date=iso-strict --pretty=format:"%ad>%aN>%aE>%s" > log.txt ``` #### Для офлайн просмотра ``` git --no-pager log --raw --numstat --oneline --all --reverse --date=iso-strict --pretty=format:"%ad>%aN>%aE>%s" | sed -e 's/\\/\\\\/g' | sed -e 's/`/"/g' | sed -e 's/^/report.push(\`/g' | sed 's/$/\`\);/g' | sed 's/\$/_/g' > log.txt ``` Git создаст файл `log.txt`. Он содержит данные для построения отчёта. Разница между онлайн и офлайн форматом в наличие обёртки для строк. Оффлайн формат будет подтягиваться, как `js` файл если вы просто открыли `/build/index.html` #### Если вы используете PowerShell в Windows По умолчанию, поток вывода не совпадает с UTF-8 и итоговый файл становится нечитаемым. Перед сохранением файла с логом вы можете изменить кодировку командой: ``` [Console]::OutputEncoding = [System.Text.Encoding]::UTF8 ``` Или откройте сохраненный файл и вручную измените кодировку на UTF-8. ### 📈 Как посмотреть отчёт? #### Онлайн - Перейти на [сайт](https://assayo.online/) - Нажать кнопку «[Демо](https://assayo.online/demo?ref=github&lang=ru)» - Перетащить файл `log.txt` в окно браузера #### Офлайн - Скачать этот репозиторий - Перетащить файл `log.txt` в папку `/build` - Запустить `/build/index.html` - Или перетащить папку `/build` к себе в репозиторий (туда, где лежит `log.txt`). Можно сменить название. Например с `/build` на `/report` В этом случае важно, чтобы файл `log.txt` был сгенерирован командой для офлайн просмотра. ### 🏭 Как пересобрать файл отчёта из исходного кода? - Скачать этот репозиторий - Выполнить `npm install` - Выполнить `npm run build:local` - Свежая сборка будет в папке `/build` ### 🗃️ Как посмотреть отчёт по группе микросервисов? - Сгенерировать для каждого микросервиса файл `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` и т.д.). Вы можете сделать это в ручную, или использовать модуль [Assayo Crawler](https://github.com/bakhirev/assayo-crawler) для автоматического сбора логов; - См. «Как посмотреть отчёт онлайн?». На последнем шаге перетащить сразу все файлы в окно браузера. - См. «Как посмотреть отчёт офлайн?». На втором шаге перетащить все файлы микросервисов (`log-1.txt`, `log-2.txt`, `log-3.txt` и т.д.) в папку отчета (`/build`). ### 🎨 Как брендировать интерфейс? Вы можете написать свою тему для интерфейса. Можно менять: - **Заголовок**. Вы можете указать его в URL-параметре ```title```. Например: ```?title=You Company``` - **Визуальную тему**. Для этого нужно подготовить CSS файл с новыми стилями и указать его адрес в URL-параметре ```theme```. Например: ```?theme=//company.com/some.css```. Вы можете использовать имена классов в качестве селекторов. Большинство из них не меняется в при выходе новой версий. - **Язык**. Вы можете указать его в URL-параметре ```lang```. Например: ```?lang=es``` ### 📝 Как подписывать коммиты? Следуйте практике [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Например: ``` JIRA-1234 feat(profile): Added avatar for user ``` - номер задачи в таск трекере `(JIRA-1234)` - тип работы `(feat, fix, style, refactor, test, doc и т.д.)` - фича `(profile - раздел сайта, страница или новый функционал, одним словом)` - какую проблему решали `(Added avatar for user)` ### 👮 Как добавить проверку текста коммита? #### Используя файл `commit-msg` 1. Создайте файл `commit-msg` в папке `.git/hooks/` 2. Добавьте в файл следующий текст: ``` #!/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 ``` #### Используя пакет [pre-commit](https://www.npmjs.com/package/pre-commit) 1. Добавьте в файл `package.json` блок `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. Выполните команду `npm install pre-commit` ### 📚 Как автоматизировать сбор данных? #### С бекендом - используйте модуль [Assayo Crawler](https://github.com/bakhirev/assayo-crawler); #### Без бекенда - создайте клон нужного вам репозитория; - скопируйте в корень папку `build`; - откройте `build/index.html` в браузере и добавьте в закладки; - добавьте ярлык на `build/assets/ci-cd.sh` в папку автозагрузки (Windows); Каждый раз, при перезагрузке компьютера, скрипт будет обновлять статистику по всем данным, которые автоматически влились в основную ветку. ### 🛠️ DevOps (CI/CD) #### Публичный сервер Вы можете выкладывать файл с данными для построения отчёта на публичный URL. А для его визуализации использовать веб-интерфейс сайта [assayo](https://assayo.online/). Просто укажите адресс, где лежат данные, в URL-параметре ```dump```: ``` https://assayo.online/demo/?dump=//you_site.com/some/log.txt ``` #### Приватный сервер - скачайте [docker образ](https://hub.docker.com/r/bakhirev/assayo); - поднимите его в локальной сети; - для просмотра отчётов используйте веб-интерфейс указывая ему адресс, где лежат данные, в URL-параметре ```dump```: ``` http://assayo_url/?dump=//you_url/some/log.txt assayo_url - URL адресс контейнера assayo, он слушает 80 порт; you_url - URL адресс вашего контейнера с логами git; ``` По умолчанию образ запустится по адресу ```http://127.0.0.1:80/```. Если не получилось проверьте свободен ли у вас 80 порт. #### Обновление Docker-образа - собрать билд ```npm run build:docker``` - собрать образ ```docker build -t assayo .``` - визуально проверить образ ```docker run --name assayo -p 80:80 -d assayo```; - поставить тег ```docker tag assayo bakhirev/assayo:latest```; - запушить образ в Docker Hub ```docker push bakhirev/assayo:latest```; ### 🛠️ ️ О приложении #### 📐 Архитектура 1. [Reports showcase UI](https://github.com/bakhirev/assayo-showcase) отображение списка отчётов. Каждый отчёт имеет название, описание и список репозиториев. 2. [Crawler service](https://github.com/bakhirev/assayo-crawler) сборка, склейка, обработка логов из репозиториев для отчётов. 3. [Log visualization UI](https://github.com/bakhirev/assayo) **(вы тут)** отображение отчётов. Для работы ему нужен log файл с данными. #### 🈯 Релизы, примерно, раз в полгода. Что дальше: - больше советов и достижений; - итоги года / месяца, печать отчётов; - локализация и интернационализация; - анализ файлов; - разные роли для статистики (скрытие финансов); - разработка бекенда, интеграции с другими системами; #### 🗺️ Как добавить или отредактировать перевод? Вы можете добавить новый перевод или поправить текущий в разделе ```ts/translations/```. [Инструкция](https://github.com/firstcontributions/first-contributions) #### 📧 Пожелания, предложения, замечания - telegramm [@bakhirev](https://t.me/bakhirev) (приоритетный способ связи) - [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru) - сайт [https://assayo.online/](https://assayo.online/?ref=github&lang=ru)