How do you structure your Git repository?

Ask Questions
1

How do you structure your Automation Studio Project Git repository?
Do you have the project directly in the root folder or do you have it in an subdirectory?
What are the advantages of each solution or do you do something else?
Would be very interesting for me.

Thank you all!

2

Hello,

You can use subdirectory to keep your projects in different folders for different machines.

You can save a lot of storage when you use a .gitignore file like the one below.

Binaries/**
Temp/**
Diagnosis/**
*.isopen
*.set
*.zip

An AS project does not need the above files to execute. These files keep personal settings, temporary files, and some objects created during transfer. Recompiling the project will create them automatically. You should upload just the Logical, Physical folders, and the .apj file to the Git repository.

1 Like
3

For me, the answer depends on if there will be other stuff in the repository. For example, if I have a lot of documentation (that isn’t part of the AS project itself), then a structure like this makes sense

  • Repo
    • AS Project (.apj file, etc.)
    • Documentation

This means AS doesn’t have to worry about “seeing” any other files in the repository besides the project files.

However, this looks a little silly if the only thing in the repository is the project, so I usually default to putting the project in the root directory of the repo unless something compels me to move it.

As Hakan said, it’s helpful to have a .gitignore that ignores the files you don’t need to commit. You can have multiple of these at different levels (for instance, if you had two AS projects in one repository…for some reason).

4

I also vote for markus’ solution and use mostly a subdir for the AS project.
Some projects go into a Bitbucket server, some of them to Github and the root of the repo is then used for README.md, LICENCE, .gitignore etc.
And there might be some other directories for docs, scripts …