Skip to content

Conversation

@kinkie
Copy link
Contributor

@kinkie kinkie commented Nov 2, 2023

Start adding documentation about the automations supporting the project

@kinkie kinkie requested review from rousskov and yadij November 2, 2023 21:02
Jenkins administrators can at any point force the execution of these jobs
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. [master artifacts](https://build.squid-cache.org/job/website-tarballs-head/lastSuccessfulBuild/artifact/artifacts/).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
e.g. [master artifacts](https://build.squid-cache.org/job/website-tarballs-head/lastSuccessfulBuild/artifact/artifacts/).
e.g. [development version artifacts](https://build.squid-cache.org/job/website-tarballs-head/lastSuccessfulBuild/artifact/artifacts/).

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. [master artifacts](https://build.squid-cache.org/job/website-tarballs-head/lastSuccessfulBuild/artifact/artifacts/).
1. A cron job running (mk-release-snapshots.sh) running on on master downloads these artifacts,
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
1. A cron job running (mk-release-snapshots.sh) running on on master downloads these artifacts,
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,


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 master,
while `6-matrix` and `5-matrix` are (at this time) used for the stable and old releases
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
while `6-matrix` and `5-matrix` are (at this time) used for the stable and old releases
while a version specific `N-matrix` (e.g. `6-matrix` or `5-matrix`) are used for the stable and old releases

[trunk-arm64-matrix](https://build.squid-cache.org/job/trunk-arm64-matrix/) is used for master,
while `6-matrix` and `5-matrix` are (at this time) 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 trunk).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
(e.g. [website-tarballs-head](https://build.squid-cache.org/job/website-tarballs-head/) for trunk).
(e.g. [`website-tarballs-head`](https://build.squid-cache.org/job/website-tarballs-head/) for the `trunk_amd64_matrix`).

while `6-matrix` and `5-matrix` are (at this time) 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 trunk).
The tarball jobs trust that if they are invoked, it's because the branch is stable.
Copy link
Contributor

Choose a reason for hiding this comment

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

"stable" is often misinterpreted as "production ready". Our meaning here is more specific, so lets be clear.

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

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 master,
Copy link
Contributor

Choose a reason for hiding this comment

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

Lets be clear this is the VCS branch we use "master" later to mean the server.

Suggested change
[trunk-arm64-matrix](https://build.squid-cache.org/job/trunk-arm64-matrix/) is used for master,
[`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/),

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 trunk).
The tarball jobs trust that if they are invoked, it's because the branch is stable.
Jenkins administrators can at any point force the execution of these jobs
Copy link
Contributor

Choose a reason for hiding this comment

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

punctuation typo.

Suggested change
Jenkins administrators can at any point force the execution of these jobs
Jenkins administrators can, at any point, force the execution of these jobs.

(e.g. [website-tarballs-head](https://build.squid-cache.org/job/website-tarballs-head/) for trunk).
The tarball jobs trust that if they are invoked, it's because the branch is stable.
Jenkins administrators can at any point force the execution of these jobs
1. The code run there is [make-snapshot.sh](https://github.com/kinkie/support-tools/blob/master/squid-ci/make-snapshot.sh).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
1. The code run there is [make-snapshot.sh](https://github.com/kinkie/support-tools/blob/master/squid-ci/make-snapshot.sh).
1. The code run there is [`make-snapshot.sh`](https://github.com/kinkie/support-tools/blob/master/squid-ci/make-snapshot.sh).

@kinkie
Copy link
Contributor Author

kinkie commented Nov 3, 2023

For some reason GitHub is preventing me from merging changes or pushing -

@kinkie kinkie closed this Nov 3, 2023
@kinkie
Copy link
Contributor Author

kinkie commented Nov 3, 2023

Closing the PR and creating a new one

@kinkie kinkie deleted the project-infra branch November 3, 2023 09:35
@kinkie kinkie mentioned this pull request Nov 3, 2023
@rousskov
Copy link
Contributor

rousskov commented Nov 3, 2023

For some reason GitHub is preventing me from merging changes or pushing

Please do not abuse official repositories for PR branches. Use your own repository. We have discussed this before.

@rousskov rousskov removed their request for review October 22, 2024 17:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants