Aller au contenu principal

Versions Canary

Docusaurus a un système de versions canary.

Il vous permet de tester de nouvelles fonctionnalités inédites dès que les pull requests sont fusionnées sur la prochaine version de Docusaurus.

C'est un bon moyen de donner un feedback aux mainteneurs, en s'assurant que la fonctionnalité nouvellement implémentée fonctionne comme prévu.

remarque

Utiliser une version canary en production peut sembler risqué, mais en pratique, ce n'est pas le cas.

Une version canary passe tous les tests automatisés et est utilisée en production par le site Docusaurus lui-même.

attention

La version canary indiquée ci-dessous peut ne pas être à jour. Veuillez aller sur la page npm pour trouver le nom de la version actuelle.

Canary npm dist tag​

Pour tout commit lié au code sur main, l'intégration continue publiera une version canary sous le tag @canary npm dist. Cela prend généralement jusqu'à 10 minutes.

Vous pouvez voir sur npm les tags dist actuels :

  • latest : versions stables (actuellement : 3.2.1)
  • canary : versions canary (Exemple : 0.0.0-4922)
astuce

Veillez à utiliser la dernière version de Canary et vérifiez la date de publication (il arrive que le processus de publication échoue).

remarque

Les versions Canary suivent la convention de nommage 0.0.0-numéroCommit.

Utilisation d'une version canary​

Prenez la dernière version publiée sous la balise canary npm dist tag (Exemple : 0.0.0-4922).

Utilisez-la pour toutes les dépendances @docusaurus/* de votre package.json :

-  "@docusaurus/core": "^3.2.1",
-  "@docusaurus/preset-classic": "^3.2.1",
+  "@docusaurus/core": "0.0.0-4922",
+  "@docusaurus/preset-classic": "0.0.0-4922",

Ensuite, réinstallez les dépendances et démarrez votre site :

npm install
npm start

Vous pouvez également mettre à jour les paquets @docusaurus/* avec la ligne de commande :

npm install --save-exact @docusaurus/core@canary @docusaurus/preset-classic@canary
attention

Assurez-vous d'inclure tous les paquets @docusaurus/*.

Pour les versions canary, préférez l'utilisation d'une version exacte au lieu d'une plage semver (évitez le préfixe ^).