assayo/documents/FR.md

English | Español | 中文 | Français | Deutsch | Português | 日本語 | Русский

Assayo

Crée un rapport HTML avec analyse des statistiques de validation:

• le rythme de travail et le nombre d'heures supplémentaires;
• les zones de responsabilité, le nombre de fonctionnalités et de bogues;
• le style de travail de vos collègues;
• le taux de rotation du personnel et la composition de l'équipe;
• l'emplacement des développeurs;
• le calendrier des publications et des vacances;
• le coût des fonctionnalités et du projet dans son ensemble;
• les endroits pour le refactoring, les fichiers supprimés, etc.

Links: demo, online version, docker, reddit, habr.

Video: english, español, русский.

Table of contents

• COMMIT STATISTICS REPORT

  • Comment voir le rapport en ligne?
    • Using website
    • Use the library NodeJS
    • Use the library PHP
    • Use the library Python
    • Use the library Ruby
    • Use the library Go
    • Use source code
    • Use github actions
    • Serveur privé
  • Comment pouvez-vous combiner les auteurs ?
  • Comment télécharger des données depuis git ?
    • Pour une visualisation en ligne
    • Pour la navigation hors ligne
    • If you use PowerShell in Windows
  • Comment voir le compte rendu pour un groupe de microservices?

• THE BEST PRACTICES IN THE PROJECT

  • Comment signer les commits ?
  • How to add checking for commit message?
    • Use file commit-msg
    • Use package pre-commit

• ABOUT THIS APP

  • Comment apposer une marque sur l’interface?
  • Comment recompiler la build du rapport?
  • Comment ajouter ou modifier une traduction?
  • ️Architecture
    • The structure of this module
    • General architecture of microservices
  • Souhaits, suggestions, commentaires

COMMIT STATISTICS REPORT

📈 Comment voir le rapport en ligne?

Using website

• Aller à сайт
• follow the instructions

Use the library NodeJS

• run npx assayo
• open ./assayo/index.html

Use the library PHP

• run composer require bakhirev/assayo
• run vendor/bin/assayo
• open ./assayo/index.html

Use the library Python

• run pipx install assayo
• run assayo
• open ./assayo/index.html

Use the library Ruby

• run gem install assayo
• run assayo
• open ./assayo/index.html

Use the library Go

• run go get github.com/bakhirev/assayo
• run go install github.com/bakhirev/assayo
• run assayo
• open ./assayo/index.html

Use source code

• Télécharger ce dépôt
• Glisser le fichier log.txt dans le dossier /build
• Démarrer /build/index.html
• Ou coller le dossier /build Sur votre dépôt (là où se trouve log.txt). Vous pouvez changer le nom. Par exemple avec /build sur /report. Dans cette cas, il est important que le fichier log.txt ait été généré par le commande pour la visualisation hors ligne.

Use github actions

Add script in folder .github/workflows/ or use this action from the marketplace. A ready, fresh report will be saved in the artifacts.

Serveur privé

• télécharger docker образ;
• Soulevez-le sur le réseau local;
• Pour consulter les rapports, utilisez l’interface web en lui indiquant l’adresse où les données se trouvent, sous forme de paramètre dans l’URL dump:

http://assayo_url/?dump=//you_url/some/log.txt
assayo_url - URL Conteneur assayo, écoute le port 80;
you_url    - URL адресс Adresse de votre conteneur de logs git;

Par défaut, l'image s'exécute à http://127.0.0.1:80/. Si cela ne fonctionne pas, vérifiez si le port 80 est disponible.

‍🎭 Comment pouvez-vous combiner les auteurs ?

Dans le répertoire racine de votre projet, créez le fichier suivant: .mailmap. L’exemple de la ligne de fichier est le suivant:

Alex B <alex@mail.uk>
Alex B <alex@mail.uk> <alex@gov.tk>
Alex B <alex@mail.uk> <bakhirev@ya.kz>
Alex B <alex@mail.uk> <man64@yahoo.com>

Vous pouvez en savoir plus sur le format de ce fichier en lisant la documentation officielle. ici.

📤 Comment télécharger des données depuis git ?

Pour une visualisation en ligne

Dans le répertoire racine de votre projet, exécutez:

git --no-pager log --raw --numstat --oneline --all --reverse --date=iso-strict --pretty=format:"%ad>%aN>%aE>%s" > log.txt

Pour la navigation hors ligne

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/\$/S/g' | sed -e '1s/^/R(f\`/' | sed -e '$s/$/\`\);/' > log.txt

Git va créer le fichier log.txt. Son contenu est destiné à la création de rapports. La différence entre le format en ligne et le format hors ligne réside dans l’enveloppe des lignes. Le format hors ligne sera chargé comme un fichier js si vous avez simplement ouvert /build/index.html

If you use PowerShell in Windows

By default, the output encoding may not match UTF-8 and the resulting log file will be unreadable. Before saving the log, you can change the encoding with the command.

[Console]::OutputEncoding = [System.Text.Encoding]::UTF8

Or open a saved file and manually change the encoding to UTF-8.

🗃️ Comment voir le compte rendu pour un groupe de microservices?

• générer un fichier pour chaque microservice log.txt (log-1.txt, log-2.txt, log-3.txt etc.)
• Voir “Comment voir le rapport en ligne?”. Au dernier pas, glisser tous les fichiers dans la fenêtre du navigateur.
• Voir “Comment regarder le rapport hors-ligne?”. Au deuxième pas, coller tous les fichier de microservices (log-1.txt, log-2.txt, log-3.txt etc.) dans le dossier du rapport (/build).

THE BEST PRACTICES IN THE PROJECT

📝 Comment signer les commits ?

Suivez la pratique Conventional Commits 1.0.0. Par exemple:

JIRA-1234 feat(profile): Added avatar for user 

• numéro de tâche dans task Tracker (JIRA-1234)
• type de travail (feat, fix, style, refactor, test, doc etc.)
• ficha (profile - la section du site, la page ou la nouvelle fonctionnalité, en un mot)
• quel problème ont-ils résolu (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

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

ABOUT THIS APP

🎨 Comment apposer une marque sur l’interface?

Vous pouvez écrire votre propre thème pour l’interface. Vous pouvez changer :

• En-tête. Vous pouvez le spécifier dans le paramètre de l’URL title. Par exemple: ?title=You Company
• Thème visuel.Pour cela, vous devez préparer un fichier CSS avec de nouveaux styles et indiquer son adresse dans le paramètre de l’URL theme. Par exemple: ?theme=//company.com/some.css. Vous pouvez utiliser les noms de classes comme sélecteurs. La plupart d’entre elles ne changent pas lors de la sortie de nouvelles versions.
• Langue. Vous pouvez l’indiquer dans le paramètre d’URL lang. Par exemple: ?lang=es

Example: demo

🛠️ Comment recompiler la build du rapport?

• Télécharger ce dépôt
• Exécuter npm install
• Exécuter npm run build:local
• La dernière build sera dans le dossier /build

🈯 Comment ajouter ou modifier une traduction?

Vous pouvez ajouter une nouvelle traduction ou corriger la traduction existante dans le section ts/translations/. Instruction

📐 ️Architecture

The structure of this module

src
 |- pages
    |- Person // all personal dashboards
    |- Team   // all dashboards about team
 |
 |- helpers
    |- Parser          // parse text from git log to JS objects
    |- DataGrip        // data grouping and counting values
    |- achievement     // the logic that gives out personal achievements
    |- Recommendations // the logic that gives out common recommendations
 |
 |- translations // translations into other languages

General architecture of microservices

1. Reports showcase UI displays a list of available reports. Each report consists of a title, description, and a list of repositories.
2. Crawler service collects repository logs for the report.
3. Log visualization UI (you here) displays report. Needs a log file for work.

📧 Souhaits, suggestions, commentaires

• telegramm @bakhirev (voie de communication prioritaire)
• alexey-bakhirev@yandex.ru
• site https://bakhirev.github.io/