scripts

Scripts

• Scripts
  • Input
    • Windows
    • Unix
    • Email renaming with Lua
  • Dependencies and Packages
    • Ruby gems
    • Python packages
    • Lua rocks
  • Usage
  • Script automation with GitHub Actions

Input

The git information is retrieved in the following ways, in the root of the repository:

Windows

• Open the command prompt.
• Set the LC_ALL environment variable to C.UTF-8 by running the command:

set LC_ALL=C.UTF-8

• Run the following command to generate the git information file:

git log --numstat > ./scripts/input/git.txt

Unix

• Open the terminal.
• Set the LANG environment variable to en_US.UTF-8 by running the command:

export LANG=en_US.UTF-8

• Run the following command to generate the git information file:

git log --numstat > ./scripts/input/git.txt

Email renaming with Lua

After generating the git information file, you need to anonymize the emails. Run the following command:

lua5.1 ./scripts/rename_emails.lua
# or luajit rename_emails.lua

Dependencies and Packages

Make sure you have the following dependencies installed:

Ruby gems

• Gruff
• RMagick

You can install these dependencies by running the following command:

gem install gruff rmagick

Python packages

• Pandas
• Matplotlib

You can install these dependencies by running the following command:

pip install pandas matplotlib

Lua rocks

• Luafilesystem

You can install this by running the following command:

luarocks install luafilesystem

Usage

To generate the git statistics, run the following commands:

python ./scripts/commits_per_hour.py; python ./scripts/commits_per_weekday.py
ruby ./scripts/commits_over_time.rb; ruby ./scripts/commits_type_count.rb

These commands will generate the necessary images and statistics based on the git information.

Script automation with GitHub Actions

The workflow automatically does the steps above every 3 months, it installs the necessary dependencies by checking the contents of the dependencies folder.