Generates a MermaidJS Gantt chart of a GitHub user's public repos active dates using each repo's created and pushed dates.
go run main.go <username>Generates MermaidJS file:
gantt_chart.mmd
You can also build a portable binary by just running the Makefile:
makeGenerates a binary github-repos-gantt.
Use this binary
./github-repos-gantt <username>Generates a gant_chart.mmd with contents like this:
%%{ init: {
"logLevel": "debug",
'theme': 'dark',
'themeVariables': {
'activeTaskBkgColor': '#0000ff',
'activeTaskBorderColor': 'lightgrey',
'critBorderColor': 'lightgrey',
'doneTaskBkgColor': 'grey',
'doneTaskBorderColor': 'lightgrey',
'taskBkgColor': 'black',
'taskBorderColor': 'black',
'taskTextColor': 'white',
'taskTextDarkColor': 'white',
'taskTextLightColor': 'black',
'todayLineColor': 'red'
}
}
}%%
gantt
dateFormat YYYY-MM-DD
title Repositories Gantt Chart
Nagios-Plugins : active, 2012-12-30, 2024-09-22
lib : active, 2012-12-30, 2024-09-22
Spotify-tools : active, 2012-12-30, 2024-09-22
DevOps-Perl-tools : active, 2012-12-30, 2024-09-22
spark-apps : done, 2015-05-25, 2020-04-02
lib-java : active, 2015-05-31, 2024-09-22
pylib : active, 2015-10-27, 2024-09-23
DevOps-Python-tools : active, 2015-10-27, 2024-09-23
Dockerfiles : active, 2016-01-17, 2024-09-28
DevOps-Bash-tools : active, 2016-01-17, 2024-09-28
Nagios-Plugin-Kafka : active, 2016-06-07, 2024-09-22
HAProxy-configs : active, 2018-06-08, 2024-09-22
DevOps-Golang-tools : active, 2020-04-30, 2024-09-22
Spotify-Playlists : active, 2020-06-29, 2024-09-22
SQL-scripts : active, 2020-08-05, 2024-09-21
Kubernetes-configs : active, 2020-09-16, 2024-09-21
SQL-keywords : active, 2020-09-16, 2024-09-21
Templates : active, 2020-09-16, 2024-09-25
TeamCity-CI : active, 2020-12-03, 2024-09-21
Terraform : active, 2021-01-18, 2024-09-21
Jenkins : active, 2022-01-17, 2024-09-23
GitHub-Actions : active, 2022-01-17, 2024-09-22
CI-CD : active, 2022-03-25, 2024-10-01
GitHub-Actions-Contexts : active, 2022-08-17, 2024-09-21
Diagrams-as-Code : active, 2023-04-14, 2024-10-02
Template-Repo : active, 2023-04-15, 2024-09-22
Packer : active, 2023-06-02, 2024-09-21
Vagrant-templates : active, 2023-06-12, 2024-09-21
Knowledge-Base : active, 2023-11-22, 2024-09-29
HariSekhon : active, 2024-08-14, 2024-10-02
GitHub-Commit-Times-Graph : active, 2024-09-07, 2024-09-08
GitHub-Repos-MermaidJS-Gantt-Chart : active, 2024-10-02, 2024-10-02
That can be embedded into a GitHub markdown file such as a README.md or run in MermaidJS to visualize like this:
%%{ init: {
"logLevel": "debug",
'theme': 'dark',
'themeVariables': {
'activeTaskBkgColor': '#0000ff',
'activeTaskBorderColor': 'lightgrey',
'critBorderColor': 'lightgrey',
'doneTaskBkgColor': 'grey',
'doneTaskBorderColor': 'lightgrey',
'taskBkgColor': 'black',
'taskBorderColor': 'black',
'taskTextColor': 'white',
'taskTextDarkColor': 'white',
'taskTextLightColor': 'black',
'todayLineColor': 'red'
}
}
}%%
gantt
dateFormat YYYY-MM-DD
title Repositories Gantt Chart
Nagios-Plugins : active, 2012-12-30, 2024-09-22
lib : active, 2012-12-30, 2024-09-22
Spotify-tools : active, 2012-12-30, 2024-09-22
DevOps-Perl-tools : active, 2012-12-30, 2024-09-22
spark-apps : done, 2015-05-25, 2020-04-02
lib-java : active, 2015-05-31, 2024-09-22
pylib : active, 2015-10-27, 2024-09-23
DevOps-Python-tools : active, 2015-10-27, 2024-09-23
Dockerfiles : active, 2016-01-17, 2024-09-28
DevOps-Bash-tools : active, 2016-01-17, 2024-09-28
Nagios-Plugin-Kafka : active, 2016-06-07, 2024-09-22
HAProxy-configs : active, 2018-06-08, 2024-09-22
DevOps-Golang-tools : active, 2020-04-30, 2024-09-22
Spotify-Playlists : active, 2020-06-29, 2024-09-22
SQL-scripts : active, 2020-08-05, 2024-09-21
Kubernetes-configs : active, 2020-09-16, 2024-09-21
SQL-keywords : active, 2020-09-16, 2024-09-21
Templates : active, 2020-09-16, 2024-09-25
TeamCity-CI : active, 2020-12-03, 2024-09-21
Terraform : active, 2021-01-18, 2024-09-21
Jenkins : active, 2022-01-17, 2024-09-23
GitHub-Actions : active, 2022-01-17, 2024-09-22
CI-CD : active, 2022-03-25, 2024-10-01
GitHub-Actions-Contexts : active, 2022-08-17, 2024-09-21
Diagrams-as-Code : active, 2023-04-14, 2024-10-02
Template-Repo : active, 2023-04-15, 2024-09-22
Packer : active, 2023-06-02, 2024-09-21
Vagrant-templates : active, 2023-06-12, 2024-09-21
Knowledge-Base : active, 2023-11-22, 2024-09-29
HariSekhon : active, 2024-08-14, 2024-10-02
GitHub-Commit-Times-Graph : active, 2024-09-07, 2024-09-08
GitHub-Repos-MermaidJS-Gantt-Chart : active, 2024-10-02, 2024-10-02
The init.mmd
file contains the settings that are read into the generated gantt_chart.mmd file.
init.mmd
If you've made trivial commits and pushes to update a repo's README.md or submodule updates
but not really added any substance to the code of the project, then it will appear to be a current project by the last
push date.
In such cases you may prefer to alter the end date to when you know you stopped actively working
on the project (look at the git log or git log -p) to give a more realistic ending timeline.
One solution is to generate graphs of commits per month and year to see visually where the substantial activity dropped off.
If there was recent substantial activity of README.md and submodule updates making the drop off in activity not
obvious then you can filter the git log commit count to only look at code paths.
git_graph_commit_history.sh can do both of these instantly and can be found in the epic
DevOps-Bash-tools repo.
If you've pushed an existing Git repo into a new GitHub repo the start date of the gantt chart will be too new as it's the creation date of the GitHub repo as returned by the GitHub API instead of the initial Git commit.
In most cases these are the same. Only in cases of pre-existing Git repos being pushed into new GitHub repos should you need to adjust the start date to be that of your initial Git commit date for better accuracy.
This scenario may arise when migrating a pre-existing Git repo to GitHub, or forking a subdirectory of an existing repo to a new repo to use as a shared submodule.
This program uses GitHub API's last git push date, which may not be the same as the last git commit date, but usually these are close enough together that it doesn't matter.
This is still really the last activity date of the repo and generally fine to use.
On the Gantt chart minor differences in dates are not perceptible anyway.
Regardless of the above caveats, this is still a great and fast starting point to create the Gannt chart as it automates the vast majority of creating this MermaidJS Diagram-as-Code.
In my case because I have a very complex history including many Git submodule repo forks,
many trivial commits of submodule updates and CI/CD backporting across repos I decided to exclude this activity
to give a better idea of when I was heavily actively working on each repo.
I analyzed graphs easily generated using the script
git_graph_commit_history.sh in DevOps-Bash-tools repo.
I ended up hand tuning my Gannt chart to look like this instead which is more accurate and insightful for when I was more heavily active on each repo:
%%{ init: {
"logLevel": "debug",
'theme': 'dark',
'themeVariables': {
'activeTaskBkgColor': '#0000ff',
'activeTaskBorderColor': 'lightgrey',
'critBorderColor': 'lightgrey',
'doneTaskBkgColor': 'grey',
'doneTaskBorderColor': 'lightgrey',
'taskBkgColor': 'black',
'taskBorderColor': 'black',
'taskTextColor': 'white',
'taskTextDarkColor': 'white',
'taskTextLightColor': 'black',
'todayLineColor': 'red'
}
}
}%%
gantt
dateFormat YYYY-MM-DD
title Repositories Gantt Chart
Nagios-Plugins : active, 2012-12-30, 2020-12-31
lib : active, 2012-12-30, 2015-12-31
Spotify-tools : active, 2012-12-30, 2020-12-31
DevOps-Perl-tools : active, 2012-12-30, 2020-12-31
spark-apps : done, 2015-05-25, 2020-04-02
lib-java : active, 2015-05-31, 2016-12-31
pylib : active, 2015-10-27, 2020-12-31
DevOps-Python-tools : active, 2015-10-27, 2020-12-31
Dockerfiles : active, 2016-01-17, 2022-12-31
DevOps-Bash-tools : active, 2016-01-17, 2024-12-31
Nagios-Plugin-Kafka : active, 2016-06-07, 2017-12-31
HAProxy-configs : active, 2018-06-08, 2022-12-31
DevOps-Golang-tools : active, 2020-04-30, 2024-09-22
Spotify-Playlists : active, 2020-06-29, 2024-09-22
SQL-scripts : active, 2020-08-05, 2024-09-21
Kubernetes-configs : active, 2020-09-16, 2024-09-21
SQL-keywords : active, 2013-08-13, 2020-12-31
Templates : active, 2019-11-25, 2024-09-25
TeamCity-CI : active, 2020-12-03, 2022-12-31
Terraform : active, 2021-01-18, 2024-09-21
Jenkins : active, 2022-01-17, 2024-09-23
GitHub-Actions : active, 2022-01-17, 2024-09-22
CI-CD : active, 2022-03-25, 2023-12-31
GitHub-Actions-Contexts : active, 2022-08-17, 2022-12-31
Diagrams-as-Code : active, 2023-04-14, 2024-10-02
Template-Repo : active, 2023-04-15, 2024-09-22
Packer : active, 2023-06-02, 2024-09-21
Vagrant-templates : active, 2023-06-12, 2024-09-21
Knowledge-Base : active, 2023-11-22, 2024-09-29
HariSekhon : active, 2024-08-14, 2024-10-02
GitHub-Commit-Times-Graph : active, 2024-09-07, 2024-09-08
GitHub-Repos-MermaidJS-Gantt-Chart : active, 2024-10-02, 2024-10-03
The rest of my original source repos are here.
Pre-built Docker images are available on my DockerHub.