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

Project Infra #12

wants to merge 3 commits into from

Conversation

kinkie
Copy link
Contributor

@kinkie kinkie commented Nov 3, 2023

Start adding documentation about the automations supporting the project

@kinkie
Copy link
Contributor Author

kinkie commented Nov 3, 2023

I have incorporated the changes requested in PR #11

Copy link
Contributor

@rousskov rousskov left a comment

Choose a reason for hiding this comment

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

Squid wiki (or equivalent) is not the right place for this internal Project documentation. We have https://github.com/squid-cache/ci for this kind of information. Please move this PR there (creating a branch in your own repository this time).

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.

@@ -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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants