deuill
/
grawkit
mirror of https://github.com/deuill/grawkit.git
1
0
Fork 0
Code Actions Packages
The Awksome Git Graph Generator
21 Commits 1 Branch 0 Tags 298 KiB
Awk 64.5%
Go 16%
Makefile 8.5%
CSS 6.8%
JavaScript 3.2%
Other 1%
Go to file
Alex Palaistras 892a5cec4d Render paths to end of time for branches with no final merges 
This is orthogonal to behaviour for rendering paths from the beginning of time for branches created
before the first commit, and helps frame the history in a better way.
 		2019-08-06 12:51:57 +01:00
tests Render paths to end of time for branches with no final merges 2019-08-06 12:51:57 +01:00
.editorconfig First version of Grawkit, with simple single-branch test 2016-10-30 23:17:54 +00:00
LICENSE First version of Grawkit, with simple single-branch test 2016-10-30 23:17:54 +00:00
Makefile Simplify merge handling, add more tests 2019-08-06 12:29:25 +01:00
README.md README: Add license badge, link to Orthogonal Git post 2017-01-12 23:06:23 +00:00
grawkit Render paths to end of time for branches with no final merges 2019-08-06 12:51:57 +01:00

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.

Status & Examples

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, presented here:

Command-Line Generated Graph 
git commit -m "Adding a new commit"
git commit
 
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
 
git branch test-merging


git commit -m "Commit on master"
git commit -m "Still on master"


git checkout test-merging
git commit -m 'A sample commit'


git checkout master
git commit -m "Another master commit"


git merge test-merging
 
git commit -m "Commit on master"


git branch test-first
git branch test-second


git commit -m "Still on master"
git tag v.1.0.0


git checkout test-first
git commit


git branch test-third


git checkout test-second
git commit
git merge test-first
git tag v.2.0.0-rc1


git checkout master
git merge test-second


git checkout test-third
git commit
 
git branch develop
git checkout develop
git commit


git branch feature/XYZ-12_fix-foo
git checkout feature/XYZ-12_fix-foo
git commit
git commit


git checkout develop
git branch feature/ZZ-704_take-it-to-the-limit
git checkout feature/ZZ-704_take-it-to-the-limit
git commit


git checkout develop
git merge feature/XYZ-12_fix-foo


git branch feature/ABC-66_make-bar
git checkout feature/ABC-66_make-bar
git commit
git commit


git checkout develop
git merge feature/ZZ-704_take-it-to-the-limit

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.