Skip to content

Mise à jour des composants et gestion des versions

Itérez les versions des composants publiés, corrigez les problèmes ou ajoutez de nouvelles fonctionnalités.

Processus de mise à jour

1. Télécharger le composant

Allez dans « Mes composants », trouvez le composant à mettre à jour et cliquez sur le bouton « Mettre à jour ». Sur la page de mise à jour :

  1. Cliquez sur « Télécharger » pour obtenir la version actuelle
  2. Sélectionnez le chemin d'enregistrement (répertoire des composants du projet)
  3. Confirmez que le téléchargement est terminé

2. Modification locale

Ouvrez le dossier du composant téléchargé dans votre projet et effectuez les modifications :

  • Corrigez les bogues
  • Ajoutez de nouvelles fonctionnalités
  • Optimisez les performances
  • Mettez à jour la documentation

3. Test et validation

Testez le composant modifié dans l'environnement local pour vous assurer que :

  • Les fonctions d'origine fonctionnent normalement
  • Les nouvelles fonctionnalités fonctionnent comme prévu
  • Aucune erreur de console

4. Téléverser la mise à jour

Revenez à la page de mise à jour de comp-hub :

  1. Sélectionnez le dossier du composant modifié
  2. Mettez à jour le numéro de version (si le contenu du fichier a changé)
  3. Ajustez la configuration d'aperçu (si nécessaire)
  4. Modifiez la description du composant (il est recommandé d'expliquer les changements)
  5. Cliquez sur « Mettre à jour » pour publier

Spécification du numéro de version

Les versions des composants suivent la spécification Semantic Versioning :

major.minor.patch
Type de versionContenu du changementExemple
Version de patchCorrections de bogues, rétrocompatible1.0.0 → 1.0.1
Version mineureNouvelles fonctionnalités, rétrocompatible1.0.0 → 1.1.0
Version majeureChangements cassants1.0.0 → 2.0.0

Quand mettre à jour le numéro de version

Doit être mis à jour :

  • Code du composant modifié (fichier .vue)
  • Interface des props du composant modifiée
  • Logique de comportement du composant ajustée

Pas besoin de mettre à jour :

  • Configuration d'aperçu uniquement modifiée
  • Description du composant uniquement mise à jour

Comment modifier le numéro de version

Méthode 1 : Modifier sur la page de mise à jour (recommandée)

Dans la zone de configuration de la page de mise à jour du composant, modifiez directement la zone de saisie du numéro de version, et le système mettra automatiquement à jour le fichier comp.json.

Méthode 2 : Modification manuelle locale

Modifiez manuellement le numéro de version dans comp.json dans le projet local :

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

Gestion des versions

Coexistence de plusieurs versions

La plateforme conserve toutes les versions historiques des composants. Les utilisateurs peuvent :

  • Basculer pour visualiser différentes versions sur la page d'aperçu
  • Télécharger et utiliser n'importe quelle version historique
  • Comparer les différences entre les versions

Bonnes pratiques

Journal des changements

Maintenez un journal des changements dans le README.md du composant :

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

Rétrocompatibilité

  • Essayez de maintenir une interface de props stable
  • Si vous devez déprécier une propriété, marquez-la d'abord comme dépréciée dans la documentation
  • Les changements cassants doivent augmenter le numéro de version majeure

Les composants téléversés par les utilisateurs sont open source