Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Project Infra #12

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/ProjectInfrastructure/DailySnapshotsGeneration.md
Original file line number Diff line number Diff line change
@@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For many, "stable result" means "the same result over several tests (including the same failure)". I am guessing that we want to describe a different condition:

Suggested change
The tarball jobs trust that if they are invoked, it's because the branch has a stable build and testing result.
The tarball creation jobs trust that they are only invoked for the branch that has passed build tests.

or, more accurately and to the point:

Suggested change
The tarball jobs trust that if they are invoked, it's because the branch has a stable build and testing result.
The tarball creation jobs do not verify whether the branch passes build tests.

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
3 changes: 3 additions & 0 deletions docs/ProjectInfrastructure/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Project Infrastructure documentation

{% include pages-list-by-path.html dir=page.dir %}
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use a more specific term than Project Infrastructure. Too many things fall into this category!

is set up
- Other [external links](/ExternalLinks)