Skip to content

Commit c508c23

Browse files
committed
Add section about cross-arch testing to CONTRIBUTING.md
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent b672ff1 commit c508c23

File tree

7 files changed

+189
-0
lines changed

7 files changed

+189
-0
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,3 +193,30 @@ These are the steps to create a new release:
193193
eventually too).
194194

195195
7. Celebrate!
196+
197+
## Cross-Arch Testing
198+
199+
This project has built-in support for testing across multiple architectures.
200+
Currently, our CI conducts tests on `arm64` machines using QEMU emulation. We
201+
also have the flexibility to expand this support to include additional
202+
architectures in the future.
203+
204+
This project contains Dockerfiles that can be used in the CI to test the
205+
python package in non-native machine architectures, e.g., `arm64`. The
206+
Dockerfiles exist in the directory `.github/containers/nox-cross-arch`, and
207+
follow a naming scheme so that they can be easily used in build matrices in the
208+
CI, in `nox-cross-arch` job. The naming scheme is:
209+
210+
```
211+
<arch>-<os>-python-<python-version>.Dockerfile
212+
```
213+
214+
E.g.,
215+
216+
```
217+
arm64-ubuntu-20.04-python-3.11.Dockerfile
218+
```
219+
220+
If a Dockerfile for your desired target architecture, OS, and python version
221+
does not exist here, please add one before proceeding to add your options to
222+
the test matrix.

cookiecutter/{{cookiecutter.github_repo_name}}/CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,3 +204,30 @@ These are the steps to create a new release:
204204
eventually too).
205205

206206
7. Celebrate!
207+
208+
## Cross-Arch Testing
209+
210+
This project has built-in support for testing across multiple architectures.
211+
Currently, our CI conducts tests on `arm64` machines using QEMU emulation. We
212+
also have the flexibility to expand this support to include additional
213+
architectures in the future.
214+
215+
This project contains Dockerfiles that can be used in the CI to test the
216+
python package in non-native machine architectures, e.g., `arm64`. The
217+
Dockerfiles exist in the directory `.github/containers/nox-cross-arch`, and
218+
follow a naming scheme so that they can be easily used in build matrices in the
219+
CI, in `nox-cross-arch` job. The naming scheme is:
220+
221+
```
222+
<arch>-<os>-python-<python-version>.Dockerfile
223+
```
224+
225+
E.g.,
226+
227+
```
228+
arm64-ubuntu-20.04-python-3.11.Dockerfile
229+
```
230+
231+
If a Dockerfile for your desired target architecture, OS, and python version
232+
does not exist here, please add one before proceeding to add your options to
233+
the test matrix.

tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,3 +154,30 @@ These are the steps to create a new release:
154154
eventually too).
155155

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

tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,3 +198,30 @@ These are the steps to create a new release:
198198
eventually too).
199199

200200
7. Celebrate!
201+
202+
## Cross-Arch Testing
203+
204+
This project has built-in support for testing across multiple architectures.
205+
Currently, our CI conducts tests on `arm64` machines using QEMU emulation. We
206+
also have the flexibility to expand this support to include additional
207+
architectures in the future.
208+
209+
This project contains Dockerfiles that can be used in the CI to test the
210+
python package in non-native machine architectures, e.g., `arm64`. The
211+
Dockerfiles exist in the directory `.github/containers/nox-cross-arch`, and
212+
follow a naming scheme so that they can be easily used in build matrices in the
213+
CI, in `nox-cross-arch` job. The naming scheme is:
214+
215+
```
216+
<arch>-<os>-python-<python-version>.Dockerfile
217+
```
218+
219+
E.g.,
220+
221+
```
222+
arm64-ubuntu-20.04-python-3.11.Dockerfile
223+
```
224+
225+
If a Dockerfile for your desired target architecture, OS, and python version
226+
does not exist here, please add one before proceeding to add your options to
227+
the test matrix.

tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,3 +154,30 @@ These are the steps to create a new release:
154154
eventually too).
155155

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

tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,3 +154,30 @@ These are the steps to create a new release:
154154
eventually too).
155155

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

tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,3 +154,30 @@ These are the steps to create a new release:
154154
eventually too).
155155

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

0 commit comments

Comments
 (0)