Should I include build and dist folders in github, or just spec file?

Should I include build and dist folders in github, or just spec file?

I am using PyQt and Install Forge for an internal tool I am building for my current job, I cannot find any internal guides on whether I should be including my dist and build folders as generated by pyinstaller into my main repo (I am the admin of the repo for this specific application, it is a testing application for a mechanical rig and is about 10 files across 3 folders. I am working with the hardware team and the software team is in a different office.

I can't find much precedent in other repos and was wondering if there was a consensus here. The dist and build are bloating the repo size and aren't necessary since new users can build using the build command from pyinstaller with the spec. Thanks again, I know this question might be silly, I am new to working in the massive company repo and am used to just doing whatever I want for my own personal projects. Just opinions would be helpful if anything else.

Answer

I would say try to avoid including those generated files because as you said it can lead to bloat and if you want to share the built application, consider using github releases instead of including them in the main codebase. However, make sure to document the build process in your project’s README or a separate documentation file. This way, new users will know how to build the application without needing the pre-built binaries.

Enjoyed this question?

Check out more content on our blog or follow us on social media.

Browse more questions