areusch commented on code in PR #11927: URL: https://github.com/apache/tvm/pull/11927#discussion_r908849531
########## ci/README.md: ########## @@ -0,0 +1,97 @@ +<!--- Licensed to the Apache Software Foundation (ASF) under one --> +<!--- or more contributor license agreements. See the NOTICE file --> +<!--- distributed with this work for additional information --> +<!--- regarding copyright ownership. The ASF licenses this file --> +<!--- to you under the Apache License, Version 2.0 (the --> +<!--- "License"); you may not use this file except in compliance --> +<!--- with the License. You may obtain a copy of the License at --> + +<!--- http://www.apache.org/licenses/LICENSE-2.0 --> + +<!--- Unless required by applicable law or agreed to in writing, --> +<!--- software distributed under the License is distributed on an --> +<!--- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --> +<!--- KIND, either express or implied. See the License for the --> +<!--- specific language governing permissions and limitations --> +<!--- under the License. --> + +# Apache TVM Continuous Integration (CI) + +## Overview + +TVM's Continuous Integration is responsible for verifying the code in `apache/tvm` and testing PRs +before they merge to inform TVM contributors and committers. These jobs are essential to keeping the +TVM project in a healthy state and preventing breakages. CI in TVM is broken into these pieces: + - Lint scripts in [`tests/lint`](../tests/lint). + - The tests themselves, all of which live underneath [`tests`](../tests). + - Definitions of test suites, with each suite defined as a separate `task_` script in + [`tests/scripts`](../tests/scripts). + - The linux test sequence (in [`Jenkinsfile`](../Jenkinsfile)), which lints and builds TVM and runs test + suites using Docker on Linux. + - The Windows and Mac test sequences (in [`.github/actions`](../.github/actions)). + - GitHub Actions that support the code review process (in [`.github/actions`](../.github/actions)). + - Tools to reproduce the CI locally (in `tests/scripts`). + - Infrastructure-as-Code that configures the cloud services that provide Jenkins for the TVM CI (in the + [`tlc-pack/ci`](https://github.com/tlc-pack/ci) repo). + +## CI Documentation Index + +The CI documentation belongs with the implementation it describes. To make that concrete, the +documentation is split like so: +1. An overview of the CI is in this file. +1. User-facing documentation lives in `apache/tvm`'s `docs/contribute` sub-directory and is served on the + [TVM docs site](https://tvm.apache.org/docs/contribute/ci.html). +2. Documentation of the tools that run TVM's various regression tests locally and the test suites + are in this sub-directory. +3. Documentation of the cloud services and their configuration lives in the + [`tlc-pack/ci`](https://github.com/tlc-pack/ci) repo. + +## Jenkins + +Jenkins runs all of the linux-based TVM CI-enabled regression tests. This includes tests against accelerated hardware such as GPUs. It excludes those regression tests that run against hardware not available in the cloud (those tests aren't currently exercised in TVM CI). The tests run by Jenkins represent most of the merge-blocking tests (and passing Jenkins should mostly correlate with passing the remaining Windows/Mac builds). Review Comment: done -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
