• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!--
2Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3
4SPDX-License-Identifier: curl
5-->
6
7# Continuous Integration for curl
8
9curl runs in many different environments, so every change is run against a
10large number of test suites.
11
12Every pull request is verified for each of the following:
13
14 - ... it still builds, warning-free, on Linux and macOS, with both
15   clang and gcc
16 - ... it still builds fine on Windows with several MSVC versions
17 - ... it still builds with cmake on Linux, with gcc and clang
18 - ... it follows rudimentary code style rules
19 - ... the test suite still runs 100% fine
20 - ... the release tarball (the "dist") still works
21 - ... it builds fine in-tree as well as out-of-tree
22 - ... code coverage does not shrink drastically
23 - ... different TLS backends still compile and pass tests
24
25If the pull-request fails one of these tests, it shows up as a red X and you
26are expected to fix the problem. If you do not understand when the issue is or
27have other problems to fix the complaint, just ask and other project members
28can likely help out.
29
30Consider the following table while looking at pull request failures:
31
32 | CI platform as shown in PR          | State  | What to look at next       |
33 | ----------------------------------- | ------ | -------------------------- |
34 | CI / fuzzing                        | stable | fuzzing results            |
35 | CI / macos ...                      | stable | all errors and failures    |
36 | FreeBSD FreeBSD: ...                | stable | all errors and failures    |
37 | LGTM analysis: Python               | stable | new findings               |
38 | LGTM analysis:  C/C++               | stable | new findings               |
39 | buildbot/curl_winssl_ ...           | stable | all errors and failures    |
40 | AppVeyor                            | flaky  | all errors and failures    |
41 | curl.curl (linux ...)               | stable | all errors and failures    |
42 | curl.curl (windows ...)             | flaky  | repetitive errors/failures |
43
44Sometimes the tests fail due to a dependency service temporarily being offline
45or otherwise unavailable, for example package downloads. In this case you can
46just try to update your pull requests to rerun the tests later as described
47below.
48
49## CI servers
50
51Here are the different CI environments that are currently in use, and how they
52are configured:
53
54### GitHub Actions
55
56GitHub Actions runs the following tests:
57
58- macOS tests with a variety of different compilation options
59- Fuzz tests ([see the curl-fuzzer repo for more
60  info](https://github.com/curl/curl-fuzzer)).
61- curl compiled using the Rust TLS backend with Hyper
62
63These are each configured in different files in `.github/workflows`.
64
65### Azure
66
67Not used anymore.
68
69### AppVeyor
70
71AppVeyor runs a variety of different Windows builds, with different compilation
72options.
73
74As of November 2021 `@bagder`, `@mback2k`, `@jay`, `@vszakats`, `@dfandrich`
75and `@danielgustafsson` have administrator access to the AppVeyor CI
76environment.  Additional admins/group members can be added on request.
77
78The tests are configured in `appveyor.yml`.
79
80### Zuul
81
82Not used anymore.
83
84### Circle CI
85
86Circle CI runs a basic Linux test suite on Ubuntu for both x86 and ARM
87processors. This is configured in `.circleci/config.yml`.
88
89You can [view the full list of CI jobs on Circle CI's
90website](https://app.circleci.com/pipelines/github/curl/curl).
91
92`@bagder` has access to edit the "Project Settings" on that page. Additional
93admins/group members can be added on request.
94
95### Cirrus CI
96
97Not used anymore.
98