- Documentation
- Contribuer
Publier le SDK
Le SDK sort de deux façons : le site (les fichiers de /v1/ et d'un dossier versionné, plus la doc et les exemples), et npm (sept paquets @tempusxr). Le site se déploie tout seul quand main est poussé. npm est une étape manuelle, car elle demande une personne avec la 2FA.
Avant de publier
pnpm lint && pnpm typecheck && pnpm format:check && pnpm check:licenses
pnpm test # construit, puis tests unitaires
pnpm test:e2e # tests navigateur
pnpm size # les budgets gzip
Puis essayez le nouveau travail sur un vrai téléphone et notez le résultat dans docs/device-matrix.md. Les cases de la feuille de route sont cochées par le développeur après ce test.
La version
Chaque paquet publié a la même version. Changez version dans les sept package.json (sdk-core, scene, sdk-capture, sdk-three, sdk-aframe, sdk-tracker-image, sdk-tracker-world). Une bêta ressemble à 0.1.0-beta.1 et se publie avec l'étiquette beta ; 1.0.0 sort en latest. Un numéro de version ne peut jamais être réutilisé sur npm.
Ajoutez une entrée dans docs/whats-new.en.md et docs/whats-new.fr.md.
Construire, vérifier, publier
pnpm release:build # build minifié sans source maps, et les six fichiers du CDN dans release/
pnpm release:check # empaquette chaque paquet et vérifie les fichiers, la licence, la version et les dépendances
npm login # comme membre de l'organisation tempusxr, avec la 2FA activée
pnpm release:publish # essai à blanc : montre ce qui partirait
pnpm release:publish --yes
Les paquets sont publiés dans le bon ordre. Après une minute ou deux :
npm view @tempusxr/sdk-three@beta version
Un nouveau paquet peut mettre quelques minutes à apparaître sur npm. Testez ensuite une installation depuis un dossier vide.
Le site et le CDN
pnpm site:build écrit site/ avec la doc, les exemples, /v1/, /v{version}/ et /starter/. Vercel publie main. /v1/ est mis en cache une heure ; /v{version}/ l'est un an et ne doit jamais changer : une correction est toujours une nouvelle version.
Si quelque chose tourne mal
- 403 à la publication : npm demande la 2FA sur votre compte. Activez-la,
npm logout,npm login, et réessayez. - 404 « Scope not found » : une nouvelle organisation met quelques minutes à apparaître. Attendez, et réessayez.
- Un paquet est à moitié publié : ceux déjà publiés sont bons. Corrigez la cause et relancez
pnpm release:publish --yespour le reste ; npm refuse une version qui existe, donc retirez ceux qui sont faits de la liste danstools/release/packages.mjspour ce passage, ou changez la version. - Une mauvaise version est sortie : publiez une version corrigée.
npm unpublishn'est permis que 72 heures et n'est pas un plan.