Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't track build artefacts #26

Closed
php1ic opened this issue Jun 16, 2019 · 0 comments · Fixed by #27
Closed

Don't track build artefacts #26

php1ic opened this issue Jun 16, 2019 · 0 comments · Fixed by #27

Comments

@php1ic
Copy link
Contributor

php1ic commented Jun 16, 2019

A lot of the files in the repo are created/modified when you compile the main document. There is no need for them to be to be tracked as either they create very noisy commits, or you have to do additional work to revert these files back to their original state before committing, in which case they no longer match the document in it's latest state.

For example, if I change the title text of the first \part{} and recompile, I have made changes to 7 files

$ git status 
On branch master
Your branch is up to date with 'origin/master'.

Changes not staged for commit:
  (use "git add/rm <file>..." to update what will be committed)
  (use "git checkout -- <file>..." to discard changes in working directory)

	modified:   Data Engineering Cookbook.aux
	modified:   Data Engineering Cookbook.log
	modified:   Data Engineering Cookbook.out
	modified:   Data Engineering Cookbook.pdf
	deleted:    Data Engineering Cookbook.synctex.gz
	modified:   Data Engineering Cookbook.tex
	modified:   Data Engineering Cookbook.toc

no changes added to commit (use "git add" and/or "git commit -a")

The important detail could easily be lost here.

Installs of texlive delete the .synctex.gz by default, unless you pass synctex=1 as an option to pdflatex.

I think a .gitignore with the following content will be a good place to start

# Ignore build artefacts
*.aux
*.log
*.lof
*.lot
*.toc
*.out
*.synctex.gz

This will keep commits, and PRs, clean and easier to follow.

andkret pushed a commit that referenced this issue Jun 16, 2019
Added .gitignore file to only track the .tex and .pdf file.
Thanks to php1ic
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant