search

adrianvlupu / C4-Builder

This is a documentation builder. You feed it .md and .puml and it exports a site, pdf, or a markdown with navigation.
https://adrianvlupu.github.io/C4-Builder/
MIT License
562 stars 93 forks source link

`.c4builder` keeps getting updated with every change making it hard to check in to Git #68

Open vithun opened 2 years ago

vithun commented 2 years ago

I thought it would be a good idea to have .c4builder checked into version control. That way, other team members all work with the same configuration.

However, this means the file keeps getting updated with every change because of the checksums that get written to it. So everyone needs to remember to commit this file with every change in a different image.

Also checksums seem to vary between operating systems (to be confirmed). I have one anecdotal evidence of my colleague's Windows machine generating a different checksum compared to my Mac.

Can we move the checksums to a separate file that can be safely .gitignored and keep the .c4builder file easy to maintain in version control?

vithun commented 2 years ago

It seems like there was historically a separate file for checksums: https://github.com/adrianvlupu/C4-Builder/commit/bc475c5340c4f94c301b7f51c2415f113b4fd2a2?w=1

Was there a reason this was moved to the main configuration file?

vithun commented 2 years ago

If you are ok with moving checksums back to a separate file, I can create a PR with the change.

vithun commented 2 years ago

This somehow got closed because I mentioned the issue in a different pull request. Reopening.

bugfest commented 2 years ago

Hi @vithun. I faced the same issue : )

I opened a PR (#72) to keep track of the image checksums in a different file