zeek/ci
Evan Typanski 04c3c2ec72 CI: Add Ubuntu Clang task
This feels more like a band-aid solution - it still requires very manual
intervention to get the next builds, but at least this way we don't rely
on whatever Clang/libc++ happens to ship with FreeBSD for the only
libc++ testing. It seems like sanitizer builds don't use libc++, but I'd
rather a dedicated Linux/Clang/libc++ task at least.
2024-10-30 09:04:24 -04:00
..
alpine Fix the scripts.policy.frameworks.telemetry.prometheus btest to use the service discovery endpoint 2024-05-31 13:30:31 -07:00
centos-stream-9 Fix the scripts.policy.frameworks.telemetry.prometheus btest to use the service discovery endpoint 2024-05-31 13:30:31 -07:00
debian-11 Fix the scripts.policy.frameworks.telemetry.prometheus btest to use the service discovery endpoint 2024-05-31 13:30:31 -07:00
debian-12 Fix the scripts.policy.frameworks.telemetry.prometheus btest to use the service discovery endpoint 2024-05-31 13:30:31 -07:00
fedora-39 Fix the scripts.policy.frameworks.telemetry.prometheus btest to use the service discovery endpoint 2024-05-31 13:30:31 -07:00
fedora-40 CI: drop Fedora 38, add 40 2024-06-17 18:45:39 -07:00
freebsd Fix the scripts.policy.frameworks.telemetry.prometheus btest to use the service discovery endpoint 2024-05-31 13:30:31 -07:00
macos CI: Remove commented openssl 1.1 workaround from macOS preparation script 2024-04-08 12:01:49 -07:00
opensuse-leap-15.5 Install procps in OpenSuse Leap images 2024-09-27 10:00:13 +02:00
opensuse-leap-15.6 Install procps in OpenSuse Leap images 2024-09-27 10:00:13 +02:00
opensuse-tumbleweed Fix the scripts.policy.frameworks.telemetry.prometheus btest to use the service discovery endpoint 2024-05-31 13:30:31 -07:00
ubuntu-20.04 Fix the scripts.policy.frameworks.telemetry.prometheus btest to use the service discovery endpoint 2024-05-31 13:30:31 -07:00
ubuntu-22.04 Fix the scripts.policy.frameworks.telemetry.prometheus btest to use the service discovery endpoint 2024-05-31 13:30:31 -07:00
ubuntu-24.04 CI: Add Ubuntu Clang task 2024-10-30 09:04:24 -04:00
windows Switch all of the conan configuration to vcpkg 2024-02-02 14:52:16 -07:00
benchmark.sh ci/benchmark: Also send CIRRUS_TASK_NAME to benchmarker API 2023-09-25 13:50:50 +02:00
build.sh Remove comment about osx-sysroot [nomail] [skip ci] 2023-01-30 15:41:37 -07:00
collect-repo-info.py Move CMake template files to separate directory 2023-06-26 13:39:59 -07:00
common.sh Rework .cirrus.yml a bit to commonize some parts 2022-05-19 09:21:55 -07:00
container-images-tag-and-push.sh cirrus/container: Polish, fix and automated pushing of images 2023-02-13 12:08:53 +01:00
find-current-version.sh cirrus/container: Polish, fix and automated pushing of images 2023-02-13 12:08:53 +01:00
init-external-repos.sh CI: Use other base64 options on macOS Sonoma too 2023-11-06 11:29:44 -07:00
pre-build.sh cirrus/ci: Add pre_build_script mechanism 2023-09-26 19:37:32 +02:00
public-ecr-cleanup.sh ci: Add public-ecr-vacuum.sh 2023-05-05 12:11:09 +02:00
README spelling: organization 2022-11-15 17:47:49 -05:00
spicy-install-analyzers.sh cirrus/ci: Add ubuntu22_spicy_task and ubuntu22_spicy_head_task 2023-09-26 19:45:07 +02:00
test-fuzzers.sh Move fuzzer corpus files to another directory 2022-08-26 13:51:30 -07:00
test.sh Revert "CI: Use ccache and a single CPU when building spicy analyzers for btests" 2024-07-10 10:02:53 +02:00
tsan_suppressions.txt Suppress a known data race during civetweb shutdown 2024-06-07 11:31:34 -07:00
update-zeekygen-docs.sh ci/update-zeekygen-docs.sh: Do output stderr by default 2023-10-11 15:18:36 +02:00
upload-coverage.sh CI: Run coverage builds for PRs, but only upload on master 2024-05-21 15:11:44 -07:00

=========================================
Continuous Integration Configuration Info
=========================================

The following pointers are aimed at maintainers to help describe a few points
about the Cirrus CI setup that may not be obvious/intuitive.

Private Test Suite
------------------

Access to the private test suite is available in CI tasks except in Pull
Requests from people that do not otherwise have write access to the zeek
repository on GitHub.  To configure this access for the
``zeek-testing-private`` repository, it uses a "deploy key" which is a single
purpose SSH key with read-only permissions.  Here's how it can be set up:

1. ``ssh-keygen -f cirrus-key``

2. Add contents of ``cirrus-key.pub`` as a new key on GitHub:
   https://github.com/zeek/zeek-testing-private/settings/keys

3. Generate a new Organization-Level Secured Variable in Cirrus CI settings at
   https://cirrus-ci.com/settings/github/zeek.  The value of the secured
   variable is the base64-encoded private key, and can be obtained from the
   output of the command: ``base64 cirrus-key``.

4. Take the ``ENCRYPTED[...]``` string generated by Cirrus and use that as the
   value of ``ZEEK_TESTING_PRIVATE_SSH_KEY`` in ``.cirrus.yml``

5. Delete the local key: ``rm cirrus-key*``

6. Commit/push the changes.

Email Notifications
-------------------

Cirrus CI doesn't feature any way to perform email notifications on failures,
so that is instead handled by a separate GitHub Action:

  https://github.com/zeek/ci-email-action

The configuration of that GitHub Action is typical: it's the
``.github/workflows/ci-notification.yml`` file, which sets SMTP/mail info
via secrets stored in GitHub for the Zeek organization:

  https://github.com/organizations/zeek/settings/secrets

The particular values used for those are currently from the Zeek project's AWS
Simple Email Service configuration.