Skip to content

Commit 0746c0b

Browse files
[ci] Move cross-arch testing instructions to CONTRIBUTING.md
Signed-off-by: Tiyash Basu <[email protected]>
1 parent afe5702 commit 0746c0b

File tree

3 files changed

+24
-26
lines changed

3 files changed

+24
-26
lines changed

.github/containers/nox-cross-arch/README.md

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

CONTRIBUTING.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,10 +115,6 @@ That said, if you want to test the actual website in **your fork**, you can
115115
always use `mike deploy --push --remote your-fork-remote`, and then access the
116116
GitHub pages produced for your fork.
117117

118-
## Cross-Arch Testing
119-
120-
This project has built-in support for testing across multiple architectures. Currently, our CI conducts tests on `aarch64` machines using QEMU emulation. We also have the flexibility to expand this support to include additional architectures in the future. For more information, see [Cross-Arch Testing](.github/containers/nox-cross-arch/README.md).
121-
122118
## Releasing
123119

124120
These are the steps to create a new release:
@@ -158,3 +154,27 @@ These are the steps to create a new release:
158154
eventually too).
159155

160156
7. Celebrate!
157+
158+
## Cross-Arch Testing
159+
160+
This project has built-in support for testing across multiple architectures. Currently, our CI conducts tests on `arm64` machines using QEMU emulation. We also have the flexibility to expand this support to include additional architectures in the future.
161+
162+
This project containers dockerfiles that can be used in the CI to test the
163+
python package in non-native machine architectures, e.g., `arm64`.
164+
The dockerfiles exist in the directory `.github/containers/nox-cross-arch`, and
165+
follow a naming scheme so that they can be easily used in build matrices in the
166+
CI, in `nox-cross-arch` job. The naming scheme is:
167+
168+
```
169+
<arch>-<os>-python-<python-version>.Dockerfile
170+
```
171+
172+
E.g.,
173+
174+
```
175+
arm64-ubuntu-20.04-python-3.11.Dockerfile
176+
```
177+
178+
If a dockerfile for your desired target architecture, OS, and python version
179+
does not exist here, please add one before proceeding to add your options to the
180+
test matrix.

docs/.github/containers/nox-cross-arch/README.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)