Skip to content

Componenten bijwerken en versiebeheer

Nieuwe versies maken van gepubliceerde componenten, problemen oplossen of nieuwe functies toevoegen.

Updateproces

1. Component downloaden

Ga naar "Mijn componenten", zoek de component die je wilt bijwerken en klik op de knop "Bijwerken". Op de updatepagina:

  1. Klik op "Downloaden" om de huidige versie op te halen
  2. Kies het opslaanpad (de componentenmap van het project)
  3. Bevestig dat de download is voltooid

2. Lokaal aanpassen

Open de gedownloade componentmap in je project en breng je aanpassingen aan:

  • Los bugs op
  • Voeg nieuwe functies toe
  • Optimaliseer de prestaties
  • Werk de documentatie bij

3. Testen en valideren

Test de aangepaste component in de lokale omgeving om te controleren dat:

  • De originele functies normaal werken
  • Nieuwe functies werken zoals verwacht
  • Er geen fouten in de console staan

4. Update uploaden

Ga terug naar de updatepagina van comp-hub:

  1. Selecteer de aangepaste componentmap
  2. Werk het versienummer bij (als de inhoud van bestanden is gewijzigd)
  3. Pas de preview-configuratie aan (indien nodig)
  4. Wijzig de componentbeschrijving (het is aanbevolen om de wijzigingen toe te lichten)
  5. Klik op "Bijwerken" om te publiceren

Specificatie van versienummers

Componentversies volgen de Semantic Versioning-specificatie:

major.minor.patch
VersietypeWijzigingsinhoudVoorbeeld
Patch-versieBugfixes, achterwaarts compatibel1.0.0 → 1.0.1
Minor-versieNieuwe functies, achterwaarts compatibel1.0.0 → 1.1.0
Major-versieBreaking changes1.0.0 → 2.0.0

Wanneer moet je het versienummer bijwerken

Moet worden bijgewerkt:

  • Aangepaste componentcode (.vue-bestand)
  • Gewijzigde props-interface van de component
  • Aangepaste gedragslogica van de component

Hoeft niet te worden bijgewerkt:

  • Alleen de preview-configuratie is aangepast
  • Alleen de componentbeschrijving is bijgewerkt

Hoe je het versienummer aanpast

Methode 1: aanpassen op de updatepagina (aanbevolen)

In het configuratiegedeelte van de component-updatepagina pas je direct het invoerveld voor het versienummer aan; het systeem werkt het bestand comp.json automatisch bij.

Methode 2: handmatig lokaal aanpassen

Pas het versienummer handmatig aan in comp.json in het lokale project:

json
{
  "name": "MyComponent",
  "version": "1.1.0"
}

Versiebeheer

Meerdere versies naast elkaar

Het platform bewaart alle historische versies van componenten. Gebruikers kunnen:

  • Op de previewpagina wisselen tussen verschillende versies
  • Elke historische versie downloaden en gebruiken
  • Verschillen tussen versies vergelijken

Best practices

Wijzigingslogboek

Houd een wijzigingslogboek bij in de README.md van de component:

markdown
## Changelog

### 1.1.0 (2024-01-15)

- Added: Support for custom theme colors
- Optimized: Improved rendering performance with large data volumes

### 1.0.1 (2024-01-10)

- Fixed: Fixed tooltip not displaying in certain situations

### 1.0.0 (2024-01-01)

- Initial version release

Achterwaartse compatibiliteit

  • Probeer de props-interface stabiel te houden
  • Als je een eigenschap wilt afschrijven, markeer deze dan eerst als deprecated in de documentatie
  • Breaking changes vereisen een verhoging van het major-versienummer

Door gebruikers geüploade componenten zijn open source