Guides: Working with Git

Some people like to commit their generated documentation in their project repositories. However, if you're a fan of Github's graphs (or any repository analysis tool for that matter), this will pollute your statistics and unnecessarily bloat up the number of commits you do.

The solution is to commit with a different author.

lidoc lib/**/*.js --output docs
git add docs
git commit -m "Update documentation." --author "Nobody <nobody@localhost>"

In fact, you may want to integrate this into your Makefile.

# Makefile
NOBODY := "Nobody <nobody@localhost>"

docs-commit: docs
  git add docs
  git commit -m "Update documentation." --author "$(NOBODY)"

.PHONY: docs-commit

This way, you can just type:

$ make docs-commit

This builds your documentation (because docs-commit depends on docs) then commits it under a different author.