CI.md (3498B)
1 <!-- 2 Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. 3 4 SPDX-License-Identifier: curl 5 --> 6 7 # Continuous Integration for curl 8 9 curl runs in many different environments, so every change is run against a 10 large number of test suites. 11 12 Every 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 25 If the pull-request fails one of these tests, it shows up as a red X and you 26 are expected to fix the problem. If you do not understand when the issue is or 27 have other problems to fix the complaint, just ask and other project members 28 can likely help out. 29 30 Consider 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_Schannel_ ... | 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 44 Sometimes the tests fail due to a dependency service temporarily being offline 45 or otherwise unavailable, for example package downloads. In this case you can 46 just try to update your pull requests to rerun the tests later as described 47 below. 48 49 ## CI servers 50 51 Here are the different CI environments that are currently in use, and how they 52 are configured: 53 54 ### GitHub Actions 55 56 GitHub 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 62 These are each configured in different files in `.github/workflows`. 63 64 ### Azure 65 66 Not used anymore. 67 68 ### AppVeyor 69 70 AppVeyor runs a variety of different Windows builds, with different compilation 71 options. 72 73 As of November 2021 `@bagder`, `@mback2k`, `@jay`, `@vszakats`, `@dfandrich` 74 and `@danielgustafsson` have administrator access to the AppVeyor CI 75 environment. Additional admins/group members can be added on request. 76 77 The tests are configured in `appveyor.yml`. 78 79 ### Zuul 80 81 Not used anymore. 82 83 ### Circle CI 84 85 Circle CI runs a basic Linux test suite on Ubuntu for both x86 and ARM 86 processors. This is configured in `.circleci/config.yml`. 87 88 You can [view the full list of CI jobs on Circle CI's 89 website](https://app.circleci.com/pipelines/github/curl/curl). 90 91 `@bagder` has access to edit the "Project Settings" on that page. Additional 92 admins/group members can be added on request. 93 94 ### Cirrus CI 95 96 Not used anymore.