Skip to content

Commit 1d8de87

Browse files
authored
Remove unused cross-arch files and docs (#547)
Cross-arch tests now run in their own native ARM runner in GitHub, so these files are not used, they are not validate and could be broken. Users that want to test on a different arch than the one they develop on would have to use a custom setup.
2 parents 207a29a + cc7dcb8 commit 1d8de87

32 files changed

Lines changed: 119 additions & 1369 deletions

File tree

.github/RELEASE_NOTES.template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
All upgrading should be done via the migration script or regenerating the templates.
1414

1515
```bash
16-
curl -sSL https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config-python/<tag>/cookiecutter/migrate.py | python3
16+
curl -sSLf https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config-python/<tag>/cookiecutter/migrate.py | python3 -I
1717
```
1818

1919
But you might still need to adapt your code:

.github/containers/nox-cross-arch/arm64-ubuntu-20.04-python-3.11.Dockerfile

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

.github/containers/nox-cross-arch/entrypoint.bash

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

.github/containers/test-installation/Dockerfile

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

.github/cookiecutter-migrate.template.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
""" # noqa: E501
2222

2323
# R0801 is similarity detection, as the template is always similar to the current script
24-
# pylint: disable=too-many-lines, too-many-locals, too-many-branches, R0801
24+
# pylint: disable=too-many-lines, too-many-locals, too-many-branches, too-many-statements, R0801
2525

2626
import hashlib
2727
import json

CONTRIBUTING.md

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -261,30 +261,3 @@ These are the steps to create a new release:
261261
should be automated eventually too).
262262

263263
7. Celebrate!
264-
265-
## Cross-Arch Testing
266-
267-
This project has built-in support for testing across multiple architectures.
268-
Currently, our CI conducts tests on `arm64` machines using QEMU emulation. We
269-
also have the flexibility to expand this support to include additional
270-
architectures in the future.
271-
272-
This project contains Dockerfiles that can be used in the CI to test the
273-
python package in non-native machine architectures, e.g., `arm64`. The
274-
Dockerfiles exist in the directory `.github/containers/nox-cross-arch`, and
275-
follow a naming scheme so that they can be easily used in build matrices in the
276-
CI, in `nox-cross-arch` job. The naming scheme is:
277-
278-
```
279-
<arch>-<os>-python-<python-version>.Dockerfile
280-
```
281-
282-
E.g.,
283-
284-
```
285-
arm64-ubuntu-20.04-python-3.11.Dockerfile
286-
```
287-
288-
If a Dockerfile for your desired target architecture, OS, and python version
289-
does not exist here, please add one before proceeding to add your options to
290-
the test matrix.

RELEASE_NOTES.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22

33
## Summary
44

5-
This release improves workflows security, adds a black migration workflow, and fixes failed migrations from version v0.16.0.
5+
<!-- Here goes a general summary of what this release is about -->
66

77
## Upgrading
88

9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
10+
911
### Cookiecutter template
1012

1113
All upgrading should be done via the migration script or regenerating the templates.
@@ -16,16 +18,20 @@ curl -sSLf https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config
1618

1719
But you might still need to adapt your code:
1820

21+
<!-- Here upgrade steps for cookiecutter specifically -->
22+
1923
## New Features
2024

25+
<!-- Here goes the main new features and examples or instructions on how to use them -->
26+
2127
### Cookiecutter template
2228

23-
- Add a `black-migration.yaml` workflow that automatically reformats code when Dependabot upgrades `black`.
29+
<!-- Here new features for cookiecutter specifically -->
2430

2531
## Bug Fixes
2632

33+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
34+
2735
### Cookiecutter template
2836

29-
- Fix migration of CI workflow matrices that used `arch`/`os` dimensions with values different from the default template. The v0.16.0 migration relied on exact string matching, so projects with customized matrix items (for example `arch: [amd64]`, `os: [ubuntu-24.04]`) could be left only partially migrated. The new migration step rebuilds the `platform` entries from the existing `arch`/`os` values and only rewrites `runs-on` when it still points to the old matrix keys.
30-
- Improve workflows security: tighten permissions, avoid potential shell injection, run Python in isolated mode, pin all dependencies using the SHA hash.
3137
- The unused cross-arch QEMU-based testing infrastructure has been removed. The `.github/containers/nox-cross-arch/` and `.github/containers/test-installation/` directories, as well as the "Cross-Arch Testing" section in `CONTRIBUTING.md`.

0 commit comments

Comments
 (0)