1
0
mirror of https://github.com/qTox/qTox.git synced 2024-03-22 14:00:36 +08:00
qTox/osx
Mick Sayson 8abe8320d2 chore(CI): Use docker for CI scripts
Motiviation:
* Reproducing issues in CI is currently difficult
* Predicting issues in CI is currently difficult if you are not on
  ubuntu 18.04
* Reproducing issues submitted from other distros is currently done by
  creating a VM of that distro and building qtox for it locally
* Documentation for how to build on different distros is out of date
* Issues on non-ubuntu distributions are not caught by CI
* Cross compiling for windows locally is not trivial
* Iterating when working with custom build scripts is slow, scripts
  don't necessarily support re-running without re-starting the docker
  container and re-building qtox again
* Updating dependencies is a pain

Changes:
* docker-compose file has been added to the root of our repo.
  After `docker compose run --rm ubuntu` (or other supported distros),
  you are ready to compile and run qtox
* Dependencies are owned by dependency install scripts in buildscripts/.
  This allows us to use the same exact dependencies in our
  OSX/windows/linux scripts
* New docker images have been added for a variety of distributions.
  These are now run in CI in a variety of configurations
  * Docker images are cached in CI so rebuild time for the majority of
    jobs is quite quick
* Build scripts have been trimmed to leverage state of docker
  containers.
  * Windows build script no longer installs anything, dependencies are
    now managed by the windows_builder docker images
  * Build scripts should now be easily re-runnable. Usage is now `docker
    compose run --rm <image>` and then run the scripts
* All artifacts are now uploaded to github after build, this means we
  can take an appimage/flatpak/exe/dmg for any given PR and try it out
  without having to build it ourselves

Notes:
* Docker image size is quite important. We have a maximum of 5GB cache
  space on github actions. The majority of the linux distro docker
  images cache at ~300-400MB, which gives us room to test ~6 distros
  after accounting for the sizes of flatpak/windows docker images
* Docker layer ordering is relatively intentional. Approximate order
  should be that large dependencies that change infrequently should be
  farther up. This lowers the amount of rebuilding we have to do when
  dependencies are updated
* download_xxx.sh scripts are the cleanest way I could find to implement
  a shared dependency map between osx scripts and docker containers.
  Although it would be nice to have a single dependency mapping file,
  splitting it into individual scripts allows us to only rebuild some
  docker layers when dependencies are updated.
* Github actions are split between docker image building and docker
  image use. This allows us to re-use the same docker images for
  multiple jobs, but only build it once
  * Unfortunately I could not find a way to de-duplicate the stitching
    between jobs, so we have a lot of copy pasta in that area
2021-12-19 14:56:05 -08:00
..
background-DMG chore(travis): Allow for Travis deployment 2016-06-07 19:42:34 -04:00
Brewfile chore(CI): Use docker for CI scripts 2021-12-19 14:56:05 -08:00
createdmg docs(copyright): update and add copyright info 2019-06-28 01:18:26 +02:00
DS_Store-DMG fix(build): correct macOS deployment 2017-01-29 14:40:46 -08:00
gplv3.rtf Move to its own folder, fix mimetype 2014-11-14 13:59:46 -08:00
info.plist Merge branch 'v1.17-dev' 2021-12-14 21:20:14 -08:00
macfixrpath chore(osx): Added macos instalation script 2017-01-29 10:07:15 +03:00
makedist.sh docs(copyright): update and add copyright info 2019-06-28 01:18:26 +02:00
qTox-Mac-Deployer-ULTIMATE.sh chore(CI): Use docker for CI scripts 2021-12-19 14:56:05 -08:00
update-plist-version.sh docs(copyright): update and add copyright info 2019-06-28 01:18:26 +02:00
welcome.txt chore: rewrite all links to the qTox repository from tux3 to qTox 2016-08-04 06:25:50 +08:00