Aller au contenu principal

Versions Canary

Docusaurus a un système de versions canary.

Il vous permet de tester les nouvelles fonctionnalités non publiées dès que les pull-requests sont fusionnées.

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.

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 : version stable (par exemple : 2.0.0-beta.0)
  • canary : versions canary (par exemple : 0.0.0-1234+4a6de5cf7)
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+hashCommit.

Utilisation d'une version canary#

Prenez la dernière version publiée sous la balise canary npm dist tag (par exemple : 0.0.0-1234+4a6de5cf7).

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

-  "@docusaurus/core": "^2.0.0-beta.0",-  "@docusaurus/preset-classic": "^2.0.0-beta.0",+  "@docusaurus/core": "0.0.0-1234+4a6de5cf7",+  "@docusaurus/preset-classic": "0.0.0-1234+4a6de5cf7",

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

npm installnpm start

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

npm install --save-exact @docusaurus/[email protected] @docusaurus/[email protected]
caution

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 ^).