docs: say what the archived status changes

The README, the setup pages and adding-a-platform tied archived to a
scraping schedule and a CI matrix that do not exist. Archived keeps a
platform out of the runs that cover every platform unless
--include-archived is passed.
This commit is contained in:
Abdessamad Derraz committed 2026-11-06 03:20:01 +01:00
1 parent ab1866fd66
commit 7b4c03afc2
7 files changed
+49 -17

No files matched your search

+4 -4
View File
@@ -1,12 +1,12 @@
#!/usr/bin/env python3
"""List available platforms for CI matrix strategy.
"""List the registered platforms.
Respects the `status` field in _registry.yml:
- active: included in CI releases and automated scraping
- archived: excluded from CI, user can generate manually
- active: listed by default
- archived: listed with --include-archived only
Usage:
python scripts/list_platforms.py # Active platforms (for CI)
python scripts/list_platforms.py # active platforms
python scripts/list_platforms.py --include-archived # archived ones too
python scripts/list_platforms.py >> "$GITHUB_OUTPUT"
"""