Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Versioning of packages doesn't follow the semantic versioning specification

Aperta
#166 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
30/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
typescript
Ambito
api, release

Direzione di ricerca

Start by reviewing the @redhat-cloud-services/host-inventory-client package versioning and the linked commit that changed HostsApi.apiHostGetHostList parameter order. Compare the published version changes with the interface break, then trace the repository's package release configuration. Done means breaking client changes are identified, documented, and released with a major-version increment rather than only a patch increment.

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

Descrizione

Hello, I recently worked with one of the API client - @redhat-cloud-services/host-inventory-client and the Inventory application (which is a consumer of this client). While I was upgrading the client dependency version from 1.0.96 to 1.0.109, I found out that the application has got broken. Debugging the problem, I realized that the HostsApi's apiHostGetHostList function parameters were modified (specifically, the order has changed, and the wrong parameters were sent by the consumer app).

I managed to fix this and this is OK to have client interface changes, however, I would love to see such breaking changes documented and reflected with the help of versioning of the package. Just incrementing the patch version is not correct, because I would expect the increment of the major version if a broken change introduced to the interface.

Just for evidence and illustration, this is the commit that changed the function parameters: https://github.com/RedHatInsights/javascript-clients/commit/b9b68398ca1f7e5b4176cd0e064e81af8c8cf01a#diff-a9f2cff91e34cf8e2a01709fba111c82cc0e22f1f5f3782607c7f789beb189aeR1907.

Lingua principale
TypeScript
Stelle
7
Fork
37
Merge medio
2g 2h
PR unite (30g)
43

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 RedHatInsights/javascript-clients

Tutte le issue di RedHatInsights/javascript-clients

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.