bug: install-stats by-release table credits smoke installs to the newest-published release, not the one installed

Chiusa
  • Qualcosa non va?
#1,622 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Una pull request collegata è già stata integrata.

  • #1623 di @Alan-Cha — integrata

Valutazione

Difficoltà
3/5
Tempo stimato
Mezza giornata
Idoneità per principianti
42/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
go, javascript, shell
Ambito
devtools, documentation

Direzione di ricerca

Start in the install-stats page code that defines renderReleases, byPublication and ciByTag, and check how compareRelease is used there. Compare with scripts/release_smoke_test_linux.sh, which picks the highest stable release. The fix assigns each smoke run to the highest stable release published at or before the run's created_at. Done when the by-release table credits v0.8.1 for the Oct 4 to Oct 14 runs, with the tag-push residuals left documented.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

bug

Problem

The by-release table on docs/install-stats/ subtracts each release's smoke-test CI installs from its Linux column. It assigns each smoke run to whichever release was published most recently when the run started (byPublication / ciByTag in renderReleases), pre-releases included.

The smoke test installs something else. A job's fresh install is the highest-versioned stable release: gh release list --exclude-pre-releases, then sort -V | tail -1 (scripts/release_smoke_test_linux.sh). The script has excluded pre-releases since it was added in d0be885c.

The two rules disagree whenever the most recently published release isn't the highest stable version:

  • A pre-release is newest. This happened from Oct 4 to Oct 14, while v0.9.0-rc.1 through rc.4 were published. Every smoke run in those windows installed v0.8.1. I confirmed this from one run log per window: each says Fresh install: v0.8.1. The page credited those runs to the rcs instead.
  • A backport is newest. For example, a v0.8.2 published after v0.9.4. The page would credit it with runs that installed v0.9.4. This hasn't happened yet.

Effect on today's page

Release Linux CI the page subtracts CI by the smoke test's rule
v0.8.1 93 8 (shows 85 people) 80 (13 people)
v0.9.0-rc.1 to rc.4 1 to 9 each 4, 25, 39, 4 (rows show ~0) none from main pushes
v0.9.0 and later unchanged unchanged

So about 72 CI installs are attributed to the wrong releases. The daily table isn't affected, because it subtracts the CI total whichever release was installed.

The page recomputes everything from data.json on each load, so fixing the rule also corrects the existing history. Nothing needs re-collecting.

Fix

Assign each run to the highest-versioned stable release published at or before the run started, using the page's existing compareRelease. That is the smoke script's own rule, applied to data data.json already has (prerelease, published_at and each run's created_at).

Known residuals

  • Tag-push runs. A run triggered by a stable tag push installs the stable version below that tag, but this rule picks the tag itself. That puts 1 install on v0.9.0 and 2 on v0.9.1 into the wrong row so far. Fixing it needs the collector to record which ref triggered each run; today the smoke run's own head_branch is main even for tag pushes.
  • Contradicting comments. The collector's header says a tag push makes the people figure run "1-2 low per job"; the page says "1-2 high". The page is right: a tag-push job also installs the tag itself, which the page doesn't subtract. The "1-2" estimate also predates the cpex steps added in #1431, which install the tag several more times per job.

Found during the review of #1457.

Lingua principale
Go
Stelle
23
Fork
44
Merge medio
16h 37m
PR unite (30g)
250

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di rossoctl/cortex

Tutte le issue di rossoctl/cortex

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.