Thunderwikibot

Z Aviary.pl wiki
Skocz do: nawigacja, szukaj

Co to jest

Docelowo Thunderwikibot ma być botem umożliwiającym automatyczne przeprowadzanie różnych operacji na naszym wiki. Obecnie jest to skrypt do zliczania liczby wpisów na stand-upach (opisywanych niżej jako obecność).

Skąd pobrać

GitHub

Jak używać

Pobieramy pliki

Sposób 1 (pobieramy plik zip)

Pobieramy plik zip z GitHuba i rozpakowujemy go

Sposób 2 (pobieramy repozytorium)

git clone https://github.com/aviarypl/thunderwikibot.git

Informacje na temat tego, jak używać Gita, pliki do pobrania - http://git-scm.com/

Konfiguracja środowiska

Jedyne co nam potrzeba, to Groovy i Java. Testowałem tylko na OS X, ale na pozostałych systemach również powinno być OK.

GNU/Linux

  • Debian/Ubuntu i kompatybilne:

sudo apt-get install groovy

  • RHEL/Fedora i kompatybilne:

sudo yum install groovy

OS X

Wcześniej trzeba zainstalować MacPorts lub Homebrew. Jeśli już mamy jedno z wymienionych:

  • MacPorts:

sudo port install groovy

  • Homebrew:

sudo brew install groovy

Windows

Pobieramy instalator z z oficjalnej strony i instalujemy. Wcześniej może być konieczna instalacja Javy.

Uruchamiamy skrypt

  • W katalogu, gdzie mamy pobrane pliki powinien znajdować się katalog groovy.
  • Wchodzimy do niego: cd groovy
  • Teraz możemy uruchomić skrypt na kilka sposobów:
    • statystyki obecności stand-upowej za ostatnie 6 miesięcy: groovy standup/standUpAttendance.groovy
    • statystyki obecności stand-upowej od określonego dnia do dnia wczorajszego (włącznie): groovy standup/standUpAttendance.groovy yyyy-MM-dd, gdzie yyyy-MM-dd należy zamienić na żądaną datę np. 2014-03-30 (jeśli nie będzie to data, kiedy odbył się stand-up, skrypt policzy obecność od najbliższego stand-upu po tej dacie). Przykład: groovy standup/standUpAttendance.groovy 2013-10-01
    • statystyki obecności stand-upowej w podanym zakresie dat: groovy standup/standUpAttendance.groovy yyyy-MM-dd yyyy-MM-dd, gdzie yyyy-MM-dd yyyy-MM-dd należy zamienić na żądane daty np. 2013-10-01 2014-03-30. Przykład: groovy standup/standUpAttendance.groovy 2013-10-01 2014-03-30

Przeglądamy wyniki

  • Skrypt po chwili wyświetli wyniki z podsumowaniem podzielonym na dwie sekcje:
    • PEOPLE
      • Team members (yyyy-MM-dd) - lista członków zespołu wg stanu na pierwszy dzień, od którego liczona jest frekwencja
      • Team members (yyyy-MM-dd) - lista członków zespołu wg stanu na ostatni dzień, do którego liczona jest frekwencja
      • Attendees - lista osób uczestniczących w stand-upach wraz z liczbą wpisów stand-upowych
      • Enough attendance - lista osób z wystarczającą frekwencją
      • Low attendance - lista osób z niską frekwencją
      • Zero attendance - lista osób, które nie uczestniczyły w żadnym ze stand-upów w podanych okresie czasu
    • NUMBERS
      • Stand-up meetings - liczba stand-upów, które odbyły się w podanych okresie
      • Team members (yyyy-MM-dd) - liczba członków zespołu wg stanu na pierwszy dzień, od którego liczona jest frekwencja
      • Team members (yyyy-MM-dd) - liczba członków zespołu wg stanu na ostatni dzień, do którego liczona jest frekwencja
      • Attendees - liczba osób uczestniczących w stand-upach wraz z liczbą wpisów stand-upowych
      • Enough attendance - liczba osób z wystarczającą frekwencją (w nawiasie przybliżony stosunek osób z wystarczającą frekwencją do liczby osób w zespole wg stanu na pierwszy dzień obliczania danych)
  • Skrypt pominie stand-upy z datą dzisiejszą i z przyszłości

Aktualizujemy pliki do najnowszej wersji

Sposób 1 (pobieramy plik zip)

Pobieramy najnowszą wersję pliku zip z GitHuba i rozpakowujemy go nadpisując wcześniej pobrane pliki

Sposób 2 (aktualizujemy pliki pobrane z repozytorium)

  • Wchodzimy do katalogu, gdzie mamy pobrane pliki z repozytorium
  • Wpisujemy: git pull