Improve TeX.gitignore to ignore Overleaf temporary files #4783
Conversation
There was a problem hiding this comment.
Pull request overview
This PR improves the TeX.gitignore template to handle Overleaf-specific temporary files. Overleaf is a widely-used online LaTeX editor that generates internal metadata and temporary files during compilation and synchronization workflows.
Changes:
- Added a new section for Overleaf-specific ignore patterns
- Added patterns to ignore Overleaf's internal metadata directory and various temporary compilation/sync artifacts
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Overleaf (online LaTeX editor) | ||
| .overleaf/ | ||
| *.synctex.gz.tmp | ||
| *.lock |
There was a problem hiding this comment.
The pattern *.lock is too broad and could inadvertently ignore legitimate lock files from other tools (e.g., package managers, build tools, or other LaTeX tools). Consider using a more specific pattern like .overleaf/*.lock or documenting which specific Overleaf lock files this targets. If Overleaf generates lock files with a specific naming pattern, use that instead.
| *.lock | |
| .overleaf/*.lock |
| .overleaf/ | ||
| *.synctex.gz.tmp | ||
| *.lock | ||
| *.partial |
There was a problem hiding this comment.
The pattern *.partial is too broad and could inadvertently ignore files that users or other tools intentionally create with '.partial' extensions. Consider using a more specific pattern that targets only Overleaf-generated partial files, such as a specific naming convention or location (e.g., .overleaf/*.partial), if Overleaf generates these files with a predictable pattern.
| *.partial | |
| .overleaf/*.partial |
| *.synctex.gz.tmp | ||
| *.lock | ||
| *.partial | ||
| *.upload |
There was a problem hiding this comment.
The pattern *.upload is too broad and could inadvertently ignore files from other upload-related workflows or tools. Consider using a more specific pattern that targets only Overleaf-generated upload files, such as .overleaf/*.upload or a more specific naming pattern if Overleaf uses one.
| *.upload | |
| .overleaf/*.upload |
1 participant
Reasons for making this change
Overleaf is a widely used online LaTeX editor.
When compiling or synchronizing projects, it generates internal metadata and temporary files that are not intended to be committed to version control, including files stored in the .overleaf/ directory.
In addition, Overleaf may generate several temporary artifacts during compilation and synchronization workflows, such as compilation-related temporary files, lock files, partially generated outputs, and upload-related auxiliary files.
These files commonly appear when downloading projects from Overleaf or when synchronizing a project between Overleaf and a local repository. Ignoring them helps keep LaTeX repositories clean, portable, and free from editor-specific or transient artifacts.
Links to documentation supporting these rule changes
If this is a new template
Not applicable this change updates the existing TeX.gitignore template.
Merge and Approval Steps