diff --git a/docs/ProjectInfrastructure/DailySnapshotsGeneration.md b/docs/ProjectInfrastructure/DailySnapshotsGeneration.md new file mode 100644 index 00000000..8f21b247 --- /dev/null +++ b/docs/ProjectInfrastructure/DailySnapshotsGeneration.md @@ -0,0 +1,17 @@ +# How daily snapshots files are generated + +As of the 2023-11-02, this is the process to generate snapshot tarballs. + +1. Jenkins jobs run at regular cadences, monitoring the repository, run a full build test. + [`trunk-arm64-matrix`](https://build.squid-cache.org/job/trunk-arm64-matrix/) is used for the + VCS ["master" branch](https://github.com/squid-cache/squid/tree/master/), + while a version specific `N-matrix` (e.g. `6-matrix` or `5-matrix`) are used for the stable and old releases +1. if these jobs are successful, they will trigger the corresponding tarball creation job + (e.g. [`website-tarballs-head`](https://build.squid-cache.org/job/website-tarballs-head/) for the `trunk_amd64_matrix`). + The tarball jobs trust that if they are invoked, it's because the branch has a stable build and testing result. + Jenkins administrators can, at any point, force the execution of these jobs. +1. 1. The code run there is [`make-snapshot.sh`](https://github.com/kinkie/support-tools/blob/master/squid-ci/make-snapshot.sh). + The artifacts it generates are replicated to buildmaster and are accessible via https. + e.g. [development version artifacts](https://build.squid-cache.org/job/website-tarballs-head/lastSuccessfulBuild/artifact/artifacts/). +1. 1. A cron job running [`mk-release-snapshots.sh`](https://github.com/squid-cache/ci/blob/main/release/mk-release-snapshots.sh) on master downloads these artifacts, + unpacks them, and makes them available for access and download on the website diff --git a/docs/ProjectInfrastructure/index.md b/docs/ProjectInfrastructure/index.md new file mode 100644 index 00000000..497c0c59 --- /dev/null +++ b/docs/ProjectInfrastructure/index.md @@ -0,0 +1,3 @@ +# Project Infrastructure documentation + +{% include pages-list-by-path.html dir=page.dir %} diff --git a/docs/index.md b/docs/index.md index 890d4835..0929759b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -48,4 +48,6 @@ mailing list, and during pull request reviews on - The book [Squid Proxy Server 3.1: Beginner's Guide](https://www.packtpub.com/squid-proxy-server-3-1-beginners-guide/book) by Kulbir Saini +- Documentation about how the project's [infrastructure](/ProjectInfrastructure) + is set up - Other [external links](/ExternalLinks)