Chicago95 icon indicating copy to clipboard operation
Chicago95 copied to clipboard
verified publisher icon grassmunk

Improve gitignore and remove binary cache files

Open rchildre3 opened this issue 5 years ago • 3 comments

  • Add in TopTotal gitignore template for related technologies used in this repo:

    • Sass
    • Qt
    • Python
    • Archives
    • Backup
    • Emacs
    • vim
    • Visual Studio Code
    • JetBrains
    • Linux
    • MacOS
    • Windows

  • Remove the binary icon cache files from the repo. They should be generated at install time by the user to prevent stale cache files. Also the binary diff of the files over time will make the git history grow unnecessarily, increase clone time.

rchildre3 avatar Jul 04 '20 06:07 rchildre3

This is great but we have some .gz and other archived files in Extras that need to exist for the various tools/techniques we use to install/import the theme.

I know this is being persnickety and I know you're trying to help out, but would you mind taking a look in what we've already got in Extras and other locations to ensure we don't accidentally ignore those files if we make updates to them?

grassmunk avatar Jul 05 '20 02:07 grassmunk

True, apologies for not testing the pre-baked .gitignore against the exsisting codebase.

However, A better way would be to package the archives such as the browser extension at build time (while using the modern cross-browser WebExtension Standard)

By distributing the files as archives the core of Git (text diffs) is broken.

The process of generating archives could be automated by CI piplines to distribute artefacts with them built in but for now this implementation builds them with the Makefile

rchildre3 avatar Jul 05 '20 21:07 rchildre3

So there's only a few places where we have to use zipped files and a few hidden files for users to use:

Compressed files:

  1. KDE SDDM: Chicago95/KDE/SDDM/Chicago95.tar.gz
  2. Auto install XFCE panel: Chicago95/Extras/Chicago95_Panel_Preferences.tar.bz2
  3. Firefox Browser theme: Chicago95/Extras/chicago5_ie4-1.0-an+fx.xpi

Hidden files:

  1. Placeholder to keep folder: Chicago95/Plus/tmp/.keepfolder
  2. gtk file used by theme: Chicago95/Extras/hidpi/.gtkrc-2.0
  3. Xsession overrides: Chicago95/Extras/override/.xsessionrc

Ignore this: ~~ I'm 100% down for automating building the compressed files but I don't know how the files are built as they were built using external tools (for example Chicago95_Panel_Preferences.tar.bz2 is built by xfce4-panel-profiles). I'm open to suggestions and I'm curious to learn more about how to build the firefox theme (its literally just a change to the banner) to be cross browser instead of having just an XPI. ~~

So I see what you mean by the make file. The theme currently doesn't rely on a make file for distribution, I don't mind removing the compressed files but in your commit I don't see a reference in any of the documentation how to build these files and our automated installer doesn't build these files either, but that can be fixed.

grassmunk avatar Jul 06 '20 03:07 grassmunk