algolia / algolia/setup-algolia-cli

Latest is not the latest actually

Offen
#7 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
JavaScript
Sterne
3
Forks
3
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Lies die README zusammen mit action.yml, insbesondere den im Issue verlinkten Version-Input in den Zeilen 6–10. Ermittle, ob der dokumentierte Default dem tatsächlichen Verhalten der Action entspricht; abgeschlossen bedeutet, dass Nutzer hinsichtlich des Defaults nicht mehr in die Irre geführt werden, wobei das Issue vorschlägt, ihn aus der README zu entfernen, falls die Implementierung unverändert bleibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
github-actions, javascript
Bereich
ci-cd, documentation
Issue-Typ
Bug
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.