The Awksome Git Graph Generator
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Alex Palaistras 7a50537810
play: Update Go module path
3 months ago
play play: Update Go module path 3 months ago
tests Render paths to end of time for branches with no final merges 4 years ago
.editorconfig First version of Grawkit, with simple single-branch test 6 years ago
LICENSE Implement initial version of Grawkit Web Playground 3 years ago
Makefile Make Grawkit POSIX-compatible, remove `gawk`-specific extensions 4 years ago
README.md Make Grawkit POSIX-compatible, remove `gawk`-specific extensions 4 years ago
grawkit Make Grawkit POSIX-compatible, remove `gawk`-specific extensions 4 years ago

README.md

Grawkit - The Awksome Git Graph Generator MIT License

Grawkit is a tool that helps build SVG graphs from git command-line descriptions, and is built in Awk.

This tool was created in support of the "Orthogonal Git Workflow" post. Yes, this took way longer to write than the post itself.

Testing & Documentation

A Makefile is provided for running tests and producing documentation for Grawkit. Run make help in the project root for more information.

A full test-suite is provided (depending only on make and awk), which should serve as a good example of the existing feature-set. Run it with make test.

Installation

Copy the included grawkit AWK script into your local search path (most commonly $HOME/.local/bin), or just use it directly in this folder. Grawkit should work with most POSIX-compatible AWK implementations, and has been tested against gawk, nawk, busybox awk, and goawk.

Status & Usage

Grawkit has basic support for common git commands such as git branch, git tag and git merge, allowing for fairly complex graphs. The integrated test-suite serves as an example, check the tests folder for more.

In order to use this tool, either run the grawkit executable against a file containing supported git commands (any command not recognized will be silently ignored), or pass these in standard input. For instance, given the following file test.txt:

git commit -m "Commit on master"
git commit -m "More stuff"

git branch test-stuff
git checkout test-stuff

git commit -m 'Testing stuff'
git commit

git checkout master
git commit

You can execute either:

cat test.txt | grawkit
# or
grawkit test.txt

Which will produce SVG markup to standard output, rendered as:

License

All code in this repository is covered by the terms of the MIT License, the full text of which can be found in the LICENSE file.