Skip to content

Commit d7f6470

Browse files
llvm-beanzdamyanp
andauthored
[Docs] Support tiers and status readability (#422)
This PR updates the README to try and improve the readability of the status block. It also sorts the builds into support tiers so that we can more clearly explain what is PR blocking and what is a priority to fix immediately. --------- Co-authored-by: Damyan Pepper <[email protected]>
1 parent 89a9082 commit d7f6470

File tree

3 files changed

+105
-25
lines changed

3 files changed

+105
-25
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,22 @@ Experimental Runtime test suite for HLSL
55

66
| Testing Machine | DXC | Clang |
77
|-----------------|-----|-------|
8-
| Windows DirectX12 AMD GPU | ![DXC](https://github.com/llvm/offload-test-suite/actions/workflows/windows-amd-dxc-d3d12.yaml/badge.svg) | ![Clang](https://github.com/llvm/offload-test-suite/actions/workflows/windows-amd-clang-d3d12.yaml/badge.svg) |
8+
| **Tier 1 Targets** |
99
| Windows DirectX12 Intel GPU | ![DXC](https://github.com/llvm/offload-test-suite/actions/workflows/windows-intel-dxc-d3d12.yaml/badge.svg) | ![Clang](https://github.com/llvm/offload-test-suite/actions/workflows/windows-intel-clang-d3d12.yaml/badge.svg) |
10-
| Windows DirectX12 NVIDIA GPU | ![DXC](https://github.com/llvm/offload-test-suite/actions/workflows/windows-nvidia-dxc-d3d12.yaml/badge.svg) | ![Clang](https://github.com/llvm/offload-test-suite/actions/workflows/windows-nvidia-clang-d3d12.yaml/badge.svg) |
11-
| Windows DirectX12 Qualcomm GPU | ![DXC](https://github.com/llvm/offload-test-suite/actions/workflows/windows-qc-dxc-d3d12.yaml/badge.svg) | ![Clang](https://github.com/llvm/offload-test-suite/actions/workflows/windows-qc-clang-d3d12.yaml/badge.svg) |
1210
| Windows DirectX12 Warp (x64 LKG) | ![DXC](https://github.com/llvm/offload-test-suite/actions/workflows/windows-amd-dxc-warp-d3d12.yaml/badge.svg) | ![Clang](https://github.com/llvm/offload-test-suite/actions/workflows/windows-amd-clang-warp-d3d12.yaml/badge.svg) |
1311
| Windows DirectX12 Warp (arm64 LKG) | ![DXC](https://github.com/llvm/offload-test-suite/actions/workflows/windows-qc-dxc-warp-d3d12.yaml/badge.svg) | ![Clang](https://github.com/llvm/offload-test-suite/actions/workflows/windows-qc-clang-warp-d3d12.yaml/badge.svg) |
14-
| Windows DirectX12 Warp (1.0.15-preview) | ![DXC](https://github.com/llvm/offload-test-suite/actions/workflows/windows-amd-dxc-warp-preview-d3d12.yaml/badge.svg) | ![Clang](https://github.com/llvm/offload-test-suite/actions/workflows/windows-amd-clang-warp-preview-d3d12.yaml/badge.svg) |
15-
| Windows Vulkan AMD GPU | ![DXC](https://github.com/llvm/offload-test-suite/actions/workflows/windows-amd-dxc-vk.yaml/badge.svg) | ![Clang](https://github.com/llvm/offload-test-suite/actions/workflows/windows-amd-clang-vk.yaml/badge.svg) |
1612
| Windows Vulkan Intel GPU | ![DXC](https://github.com/llvm/offload-test-suite/actions/workflows/windows-intel-dxc-vk.yaml/badge.svg) | ![Clang](https://github.com/llvm/offload-test-suite/actions/workflows/windows-intel-clang-vk.yaml/badge.svg) |
13+
| **Tier 2 Targets** |
14+
| macOS Apple M1 | ![DXC](https://github.com/llvm/offload-test-suite/actions/workflows/macos-dxc-mtl.yaml/badge.svg) | ![Clang & DXC](https://github.com/llvm/offload-test-suite/actions/workflows/macos-clang-mtl.yaml/badge.svg) |
15+
| **Experimental Targets** |
16+
| Windows DirectX12 AMD GPU | ![DXC](https://github.com/llvm/offload-test-suite/actions/workflows/windows-amd-dxc-d3d12.yaml/badge.svg) | ![Clang](https://github.com/llvm/offload-test-suite/actions/workflows/windows-amd-clang-d3d12.yaml/badge.svg) |
17+
| Windows DirectX12 NVIDIA GPU | ![DXC](https://github.com/llvm/offload-test-suite/actions/workflows/windows-nvidia-dxc-d3d12.yaml/badge.svg) | ![Clang](https://github.com/llvm/offload-test-suite/actions/workflows/windows-nvidia-clang-d3d12.yaml/badge.svg) |
18+
| Windows DirectX12 Qualcomm GPU | ![DXC](https://github.com/llvm/offload-test-suite/actions/workflows/windows-qc-dxc-d3d12.yaml/badge.svg) | ![Clang](https://github.com/llvm/offload-test-suite/actions/workflows/windows-qc-clang-d3d12.yaml/badge.svg) |
19+
| Windows Vulkan AMD GPU | ![DXC](https://github.com/llvm/offload-test-suite/actions/workflows/windows-amd-dxc-vk.yaml/badge.svg) | ![Clang](https://github.com/llvm/offload-test-suite/actions/workflows/windows-amd-clang-vk.yaml/badge.svg) |
1720
| Windows Vulkan NVIDIA GPU | ![DXC](https://github.com/llvm/offload-test-suite/actions/workflows/windows-nvidia-dxc-vk.yaml/badge.svg) | ![Clang](https://github.com/llvm/offload-test-suite/actions/workflows/windows-nvidia-clang-vk.yaml/badge.svg) |
1821
| Windows Vulkan Qualcomm GPU | ![DXC](https://github.com/llvm/offload-test-suite/actions/workflows/windows-qc-dxc-vk.yaml/badge.svg) | ![Clang](https://github.com/llvm/offload-test-suite/actions/workflows/windows-qc-clang-vk.yaml/badge.svg) |
19-
| macOS Apple M1 | ![DXC](https://github.com/llvm/offload-test-suite/actions/workflows/macos-dxc-mtl.yaml/badge.svg) | ![Clang & DXC](https://github.com/llvm/offload-test-suite/actions/workflows/macos-clang-mtl.yaml/badge.svg) |
2022

23+
See the [Continuous Integration](docs/CI.md) documentation for the description of support tiers and builder hardware.
2124

2225
# Prerequisites
2326

docs/BuildMachineInfo.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs/CI.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# Continuous Integration
2+
3+
## Build Support Tiers
4+
5+
### Tier 1 Configurations
6+
7+
Tier 1 configuraitons are regularly tested and expected to be known good.
8+
Builders of these configurations are enabled in pre-merge testing and PRs should
9+
not regress these configurations.
10+
11+
When these configurations fail it should be high priority to correct them.
12+
13+
Configurations:
14+
* Windows Intel GPU DirectX
15+
* Windows Intel GPU Vulkan
16+
* Windows WARP LKG x64
17+
* Windows WARP LKG arm64
18+
19+
### Tier 2 Configurations
20+
21+
Tier 2 configurations are are regularly tested and expected to be known good.
22+
Builders of these configurations are enabled in pre-merge testing and PRs should
23+
avoid regressing these configurations.
24+
25+
Because these configurations are less stable and rely more heavily on tooling
26+
outside our direct control PRs may liberally `XFAIL` new tests that only fail on
27+
Tier 2 configurations.
28+
29+
Configurations:
30+
* macOS Metal
31+
32+
### Experimental Configurfations
33+
34+
Experimental configurations are testing configurations that have been
35+
recently added and are not yet completely passing. These configurations are not
36+
included in pre-merge testing unless a PR has the `test-all` label applied to
37+
it.
38+
39+
Experimental configurations should be promoted out to other tiers once they are
40+
robustly passing.
41+
42+
Configurations:
43+
* Windows AMD GPU DirectX
44+
* Windows AMD GPU Vulkan
45+
* Windows NVIDIA GPU DirectX
46+
* Windows NVIDIA GPU Vulkan
47+
* Windows QC GPU DirectX
48+
* Windows QC GPU Vulkan
49+
50+
## Build Hardware
51+
52+
### Apple M1
53+
54+
* CPU: Apple M1
55+
* GPU: Apple M1
56+
* RAM: 16 GiB
57+
* Configurations:
58+
* macOS Metal
59+
60+
### Windows AMD GPU
61+
62+
* CPU: AMD Ryzen 7 9700X
63+
* GPU: AMD Radeon RX 9070
64+
* RAM: 32 GiB
65+
* Configurations:
66+
* Windows AMD GPU DirectX
67+
* Windows AMD GPU Vulkan
68+
69+
### Windows Intel GPU
70+
71+
* CPU: Intel Core i9-10900
72+
* GPU: Intel UHD Graphics 630
73+
* RAM: 64 GiB
74+
* Configurations:
75+
* Windows Intel GPU DirectX
76+
* Windows Intel GPU Vulkan
77+
* Windows WARP LKG x64
78+
79+
### Windows NVIDIA GPU
80+
81+
* CPU: Intel(R) Core(TM) i5-14400F
82+
* GPU: NVIDIA GeForce RTX 5070
83+
* RAM: 16 GiB
84+
* Configurations:
85+
* Windows NVIDIA GPU DirectX
86+
* Windows NVIDIA GPU Vulkan
87+
88+
### Windows Qualcomm GPU
89+
90+
* CPU: Qualcomm Snapdragon X Plus - X1P-64-100
91+
* GPU: Qualcomm Adreno X1-85
92+
* RAM: 32 GiB
93+
* Configurations:
94+
* Windows QC GPU DirectX
95+
* Windows QC GPU Vulkan
96+
* Windows WARP LKG arm64

0 commit comments

Comments
 (0)