Using .gitignore to control Git file tracking

Owned by Jacob Pagnotta
Last updated: Sept 11, 2024 by Aryn Wiebe
1 min read

When working in the Translator there may be certain files you do not want to track in a Git repository, such as files that may contain confidential information. A Git Ignore (.gitignore) file can be added to a Translator project to exclude files from being traced by Git.

How to create a .gitignore file to the Translator:

Navigate to your IguanaX component repos file. You may find this in the default location:

For Windows:

C:\ProgramData\IguanaX\config\comps\<component_guid>\dev\

For Linux:

~/.IguanaX/config/comps/<component_guid>/dev/

For Windows:

  1. Create the .gitignore hidden file

echo. > .gitignore

  1. Open the file in notepad to manually edit the file.

For Linux:

  1. Create the .gitignore hidden file

  1. Open the file in editor mode

Specify the files which you want to ignore, meaning they will be excluded from your repository.

You can also add exceptions to your exclusions. For example, you can add exceptions to the Samples folder if you have some sample data that doesn’t have any sensitive info that you want to keep in the component’s Git history (e.g. if it’s a template component).

The following example includes an example .gitignore file for sample data:

Once you’ve created your .gitignore file, any changes you commit and push to your linked upstream repository will not contain the ignored files.

You can confirm this by navigating to your Git repository and viewing the latest commits.

 

Â