algolia / algolia/setup-algolia-cli

Latest is not the latest actually

Aperta
#7 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
JavaScript
Stelle
3
Fork
3
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

In the README it is said that the default value for the `version` input is `latest`, though it's not the case anymore after https://github.com/algolia/setup-algolia-cli/commit/ecd8ce364b0b18dda462fd3edfa94d0c7da17838 (a fix for #1).

https://github.com/algolia/setup-algolia-cli/blob/ecd8ce364b0b18dda462fd3edfa94d0c7da17838/action.yml#L6-L10

Ideally, the proper implementation for `latest` is awaited. Though it may be not so straightforward as described in [the docs](https://docs.github.com/en/repositories/releasing-projects-on-github/linking-to-releases) because the file name is not static.

Anyhow, having outdated `1.2.0` as a hard-coded default version doesn't make much sense because the CLI evolves constantly. Currently it's 1.4.2. You'd have to create a new version of this action every time a new version of CLI comes out.

Or at least a correction of the README is necessary to avoid confusion. I'd suggest removing the default altogether in this case.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Leggi la README insieme ad action.yml, in particolare l’input della versione alle righe 6–10 collegato nell’issue. Determina se il valore predefinito documentato corrisponde al comportamento effettivo dell’action; il lavoro è considerato completato quando gli utenti non sono più fuorviati riguardo al valore predefinito, con l’issue che suggerisce di rimuoverlo dalla README se l’implementazione rimane invariata.

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

Valutazione

Stack tecnologico
github-actions, javascript
Ambito
ci-cd, documentation
Tipo di issue
Bug
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.