Recommended gitignore additions?

[travisfranck]

When running the create command for SDE in an existing model directory, many different files are created. Also, node packages and locks are installed into the same directory by default.

What files should be excluded from a git repo? For instance, ignore

• node_modules folder
• package-lock.json
• package.json

Should see-prep be ignored?

TIA.

[chrispcampbell]

Hi @travisfranck, when you use the create command, it copies the files from the template-default directory in the SDEverywhere repo, and in that template we have a .gitignore file that is configured to ignore the typical files that should be ignored.

That list currently is:

baselines
node_modules
sde-prep
*.vdf
*.vdfx
*.3vmfx

In a git repo, node_modules and sde-prep should be excluded because those are machine-dependent (and cache-like). The package.json and package-manager lock files (like package-lock.json or pnpm-lock.yaml) should always be included; the lock file in particular is important for repeatable builds.

[travisfranck]

Thanks -- I added them to my file.

For others: I think the issue might have been that, because I already had the model in git, when running the create command I chose to NOT initialize the directory as a git repo. Maybe the gitignore file wasn't copied into my directory, which is why I needed to post this question.