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

+3 -3
View File
@@ -3639,9 +3639,9 @@ def _main(held: contextlib.ExitStack) -> None:
# Platform mode
if args.all and args.manifest:
# Install manifests cover every registered platform: the installer
# serves each one, with or without a release pack. "Archived" means
# upstream is no longer scraped on a schedule, not that the platform
# lost its users.
# serves each one, with or without a release pack. "Archived" keeps a
# platform out of the runs that cover every platform, not out of the
# installer: it has not lost its users.
platforms = list_registered_platforms(args.platforms_dir, include_archived=True)
elif args.all:
# A release publishes the packs the registry marks release_pack and
+2 -2
View File
@@ -638,8 +638,8 @@ def generate_readme(db: dict, platforms_dir: str, db_path: str = "database.json"
lines.extend(
[
"",
"\\* Archived: the configuration is kept and the installer serves it,"
" but upstream is no longer scraped on a schedule.",
"\\* Archived: the installer serves it, and checks that cover every"
" setup include it only on request.",
]
)
+2 -2
View File
@@ -3346,8 +3346,8 @@ def setup_table(coverages: dict, registry: dict | None = None) -> list[str]:
lines += ["No ZIP: the setup is served by the command alone. "
f"[Why?](../{NO_ZIP_FAQ})", ""]
if archived:
lines += ["An archived setup keeps its page and the command. Its list is no longer "
"read again on a schedule.", ""]
lines += ["An archived setup keeps its page and the command. Checks that cover "
"every setup include it only on request.", ""]
return lines
+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"
"""