Skip to main content

Git

GitStats — замечательная статистика для git-репозитория

GitStats

Heikki Hokkanen написал классную штуку — GitStats. Эта утилита снабжает нас человекочитаемой статистикой из репозитория гит. Конечно какую-то статистику можно получить из командной строки, но это не идёт ни в какое сравнение с визуальным представлением в виде пары графиков и диаграмм.

Утилита GitStats использует CSS для для отображения стиля, шагающего в ногу со временем, и позволяет проводить глубокую кастомизацию внешнего вида финальных отчетов. Собственно, предлагаю ознакомиться с моим форком GitStats: https://github.com/iDoka/gitstats/ . К сожалению, большинство форков страдало лишь изменением файла стилей, однако существенная часть информации формируется, используя gnuplot (против которого лично ничего против не имею). Итак, помимо, полюбившихся мне шрифтов (PT family, Oswald, Montserrat) и цветовой гаммы был подвергнут изменениям вывод графиков через gnuplot, а именно:

• заменен тошнотворный красный для графиков на #00D2FF (другой прекрасный кандидат на эту роль: #14D2C8)

• заменен и уменьшен размер шрифта

• для итогового графика применено сглаживание (графика и шрифты)

• автошкалирование чиcел на осях графика: 18000 → 18k

• ..и наверняка что-то сломал в процессе изменений

Использование

В простейшем случае запуск осуществляется как:

1
gitstats  <путь к git-репо>  <путь куда писать репорт>

 Например, при запуске из корня репозитария, если хотим иметь репорт в doc/gitstats (эту папку можно добавить в .gitignore):

1
gitstats . doc/gitstats

 Кастомные настройки передаются через ключ -с, так например можно передать иное имя проекта (по умолчанию берется имя репо) и свой файл стилей, например:

1
gitstats -c project_name=bruteforcer -c style=doc/gitstats/gitstats-custom.css . doc/gitstats

 Удобно завести цель в мейкфайле, по которой пускать сбор статистики, у меня она выглядит так:

1
2
3
4
5
stat:
   @export GDFONTPATH=/usr/share/fonts/msttcore:/usr/share/fonts/webcore:$GDFONTPATH
   @rm -rf doc/gitstats/*
   @gitstats -c project_name=bruteforcer -c style=doc/gitstats/gitstats-span.css . doc/gitstats 1>&/dev/null &
   @chrome doc/gitstats/index.html

 

CLI «GitStats»

Daniel Kvist также пользуется GitStats, но настолько сильно любит командную строку, что написал пару замечательных алиасов для гит, для вывода разукрашенной истории коммитов в консоль. Для этого в файл ~/.gitconfig необходимо добавить следующую секцию:

1
2
3
[alias]
lg  = log --graph --all --format=format:'%C(bold blue)%h%C(reset) - %C(bold cyan)%aD%C(reset) %C(bold green)(%ar)%C(reset)%C(bold yellow)%d%C(reset)%n'' %C(white)%s%C(reset) %C(bold white)— %an%C(reset)' --abbrev-commit
lg2 = log --graph --all --format=format:'%C(bold blue)%h%C(reset) - %C(bold green)(%ar)%C(reset) %C(white)%s%C(reset) %C(bold white)—%an%C(reset)%C(bold yellow)%d%C(reset)' --abbrev-commit --date=relative

 Для использования: набрать в консоли git lg или git lg2

 

Читать далее

Автовставка истории изменений в техническую документацию на AsciiDoc

Задача

При написании технической документации является хорошим тоном включать секцию с историей изменений (т.н. Revision History). Как правило, сама документация также хранится в гите и имеет свою историю изменений, поэтому грех этим не воспользоваться, чтобы автоматизировать процесс.

Решение

Рассмотрим решение задачи на базе стандарта AsciiDoc, который в последнее время набирает всё большую популярность среди прогрессивно настроенных инженеров и причастных к их результатам деятельности тех.писателей.

Примем, что для истории ревизий нам необходима следующая информация:

  • дата изменения
  • имя автора изменения
  • суть изменения

Для формирования таблицы с историей ревизий используем замечательную команду git log:

1
2
3
4
5
6
7
8
9
10
11
$ git log --max-count=10 --no-merges --date=short --pretty=format:"| %ad | %an | %s"
| 2017-04-05 | Dmitry Murzinov | [ipxact2verilog] minor changes
| 2017-04-04 | Dmitry Murzinov | minor changes
| 2017-04-04 | Dmitry Murzinov | First scatch for verilog CSR generator
| 2017-04-03 | Dmitry Murzinov | Was added Make to build translate files (*.mo) for gettext
| 2017-04-03 | Dmitry Murzinov | Was added multilingual support to AsciiDoc Register Overview table
| 2017-04-03 | Dmitry Murzinov | First try to multilingual support
| 2017-04-03 | Dmitry Murzinov | an AsciiDoc Register Overview table now data width independent
| 2017-04-03 | Dmitry Murzinov | Was added dimension of fields for Regs Overview table
| 2017-04-03 | Dmitry Murzinov | Ability to generate an AsciiDoc Register Overview table
| 2017-04-03 | Dmitry Murzinov | Was added an example config file

— как видим на выходе отличная заготовка для asciidoc-таблицы.

Подробнее об опциях команды:

  • —max-count= — указываем желаемое число последних коммитов
  • —branches= — если интересуют только конкретные ветки (например release/production), указываем тут
  • —tags= — аналогично с тегами, можно задавать паттерн типа rev*.*, v?.?.? и т.п.
  • —no-merges — не выводить в лог слияния веток

У меня установлен гит довольно старый (v1.8), в новых версиях появилась кудо более гибкая кастомизация даты. Тонкую настойку на славянский формат даты «19.2.2015» в новом гите можно осуществить следующей командой:

1
git log -n 10 --date=format:'%d.%m.%Y' --pretty=format:"| %cd | %cn | %s" 

Также в зависимости от того хранится ли документация отдельно либо является частью репозитария СФ-блока будет различаться git log, возмодно потребуется указывать конкретный исходник документа или группу исходников, например:

1
git log -n 10 --pretty=format:"| %ad | %an | %s"  doc/src/IP-core.adoc

или: 

1
git log -n 10 --pretty=format:"| %ad | %an | %s"  doc/src/*.adoc

Итоговый скрипт

Получившийся скрипт выглядит следующим образом:

1
2
3
4
5
6
7
#!/bin/bash
echo ".Revision History" > $1
echo "[cols=\"^2s,^8,^26\",options=\"header\"]" >> $1
echo "|===================================================" >> $1
echo "| Date | Author | Comments" >> $1
git log --max-count=10 --date=short --pretty=format:"| %ad | %an | %s" doc/src/*.adoc >> $1
echo "|===================================================" >> $1

Вызов скрипта: 

1
./generate-revision-history.sh revhist.adoc

В сборочном .adoc-файле включаем сгенерированный файл в соответствующую секцию: 

1
2
3
4
5
[abstract]
== История изменений документа / Revision Changes
 
include::revhist.adoc[leveloffset=+1]
<<<<

Также будет полезно добавить revhist.adoc в .gitignore (как файл, генерируемый автоматически); и в мейкфайл — как зависимость при сборке конечного PDF.

 

 

Читать далее

git: советы и шпаргалки

Начальная настройка окружения

Задать имя пользователя и почтовый адрес для текущего репозитария:

1
2
git config user.name "Doka"
git config user.email my_git_mail@idoka.ru

Выполнение этой команды эквивалентно редактированию строк файла .git/config:

1
2
3
[user]
   name = Doka
   email = my_git_mail@idoka.ru

Тоже самое глобально для всех будущих репозитариев:

1
2
git config --global user.name "Doka"
git config --global user.email my_git_mail@idoka.ru

Для удобства работы можно задать короткие псевдонимы команд, например:

1
2
3
4
git config --global alias.st "status -s"
git config --global alias.di "diff"
git config --global alias.ci "commit"
git config --global alias.co "checkout"

По умолчанию git использует стандартный редактор вашей системы, которым обычно является vim. Если вы хотите использовать другой текстовый редактор, например, joe, проделайте следующее:

1
git config --global core.editor joe

Проверить используемую конфигурацию командой:

1
git config --list

Также можете проверить значение конкретного ключа, выполнив git config <key>, например:

1
git config user.name

Вывести лог коммитов в формате «Дата Автор»:

1
git log --no-merges --pretty=format:"%an %ai" | more

Использовать цветной вывод в терминале:

1
git config color.ui true

Выводить в логе коммит на одной строке:

1
git config format.pretty oneline

Интерактивный способ добавления в индекс:

1
git add -i

Помощь по использованию команд git можно получить следующими способами:

1
git help <verb>

или:

1
git <verb> --help

 

Мнение о настройке окончания строк исходников

(далее…)

Читать далее