Repository navigation
Ignore Rules
A .vxignore file at the workspace root lists files Vertex should leave out: build output, caches, logs and IDE
files. It uses .gitignore syntax, and it is a normal file, so submit it and everyone gets the same rules.
| Pattern | Matches |
|---|---|
*.log |
Any file ending in .log, at any depth. |
Saved/ |
A folder named Saved at any depth, and everything in it. A trailing / matches folders only. |
/Build/ |
Only the Build folder at the workspace root. A leading or inner / anchors the pattern to the root. |
Content/**/*.tmp |
.tmp files anywhere under Content/. ** matches any number of folders. |
file?.txt, [abc].txt
|
? is one character, [abc] one of a set. |
!Config/Local.ini |
Re-includes something an earlier pattern ignored. |
# comment |
A comment. |
The last matching pattern wins. Everything inside an ignored folder is ignored, so Intermediate/ covers
Intermediate/Build/x.obj. The .vx/ folder is never submitted.
Ignore rules apply only to untracked files, the same as git. A file already on the server stays tracked when a pattern
starts matching it, so editing .vxignore never deletes anything from the server. To stop tracking it, delete it,
submit the deletion, and then keep it ignored.
vx init writes a starter .vxignore when it recognizes the project type. Choose one with --template <name>, or
skip it with --template none.
| Template | Detected by | Ignores |
|---|---|---|
unreal |
A *.uproject file in the folder |
Binaries/, Intermediate/ (also inside plugins), Saved/, DerivedDataCache/, generated IDE project files (*.sln, *.slnx, *.xcworkspace, *.code-workspace, .vs/, .vscode/, .idea/), IDE databases and user settings, and OS files (.DS_Store, Thumbs.db, Desktop.ini) |
Contributors add templates by subclassing IgnoreTemplate in Vertex.Core.Client/IO/IgnoreTemplates/. They're
discovered automatically.
- Write
.vxignorebefore the first submit. Uploading 30 GB ofDerivedDataCache/by accident costs time and storage, and storage isn't reclaimed yet. - Ignore anything the build or editor can regenerate. Keep anything a teammate needs to open the project.
- Run
vx statusafter editing the file to check what would be submitted.