Remotion Bits Release
Utilisez cette compétence lors de la préparation et de la publication d'une nouvelle version de remotion-bits depuis ce dépôt.
Ce que fait cette compétence
Cette compétence exécute le workflow complet de publication :
- Mettre à jour la version dans
./package.json. Par défaut, une mise à jour patch sauf si l'utilisateur demande explicitement une version mineure, majeure ou une version spécifique. - Mettre à jour
CHANGELOG.mdavec des notes de release concises pour la nouvelle version. - Exécuter
npm run registry:build. - Commiter les changements de release avec
chore: vX.Y.Z. - Pusher le commit de release sur
master. - Rechercher les changements notables depuis la version précédente via l'historique git et les PRs fusionnées.
- Ouvrir le formulaire GitHub Release prérempli avec le navigateur système, pas le navigateur interne.
- Après la publication de la release GitHub, déployer la documentation avec
./scripts/deploy-docs.sh. - Publier le paquet sur npm avec
npm publish.
Prérequis
- Travailler depuis la racine du dépôt.
- Ne pas démarrer le serveur de développement de la documentation.
- Supposer que la publication nécessite des identifiants GitHub, Cloudflare et npm valides déjà configurés dans l'environnement.
- Si l'arbre de travail contient des modifications utilisateur non liées, ne pas les annuler. Soit les contourner, soit s'arrêter et demander avant d'y toucher si elles affectent les fichiers de release.
Workflow de publication
1. Déterminer la version cible
- Lire la version actuelle dans
./package.json. - Si l'utilisateur a donné une version spécifique, l'utiliser.
- Si l'utilisateur a donné un type de mise à jour, l'appliquer.
- Sinon, incrémenter le patch.
- Le tag git et le titre de la release doivent être
vX.Y.Z.
2. Préparer les notes de release
- Examiner les commits depuis le dernier tag de publication.
- Examiner les PRs fusionnées lorsqu'elles aident à résumer les changements.
- Mettre à jour
CHANGELOG.mden insérant la section de la nouvelle version en haut. - Garder les entrées concises et orientées utilisateur.
- Utiliser ce format :
### vX.Y.Z
- Fonctionnalité : Brève description d'une nouvelle fonctionnalité
- Correction : Brève description d'une correction de bogue
- Amélioration : Brève description d'une amélioration
- Documentation : Brève description d'un changement de documentation
3. Mettre à jour la version et construire le registre
- Mettre à jour
./package.jsonvers la nouvelle version. - Exécuter :
npm run registry:build
- Si la construction échoue, s'arrêter et corriger le problème sous-jacent avant de continuer.
4. Commiter et pusher la release
- Examiner le diff de la release.
- Commiter la release préparée avec :
git commit -am "chore: vX.Y.Z"
- Pusher le commit sur
master. - Si le dépôt est en retard par rapport au remote ou si le push échoue, résoudre cet état avant de continuer.
5. Rédiger la release GitHub
- Construire les notes de release à partir du résumé du changelog et des commits récents.
- Ouvrir cette URL avec
xdg-openou une autre commande système, jamais le navigateur interne :
https://github.com/everlier/remotion-bits/releases/new?tag=vX.Y.Z&target=master&title=vX.Y.Z&body=...
-
Préremplir le formulaire avec :
tag:vX.Y.Ztarget:mastertitle:vX.Y.Zprerelease:false
-
Le corps de la release doit suivre cette structure :
## Ce qui a changé
- Une phrase courte par nouvelle fonctionnalité notable.
- Une phrase courte par correction notable.
- Une phrase courte par amélioration notable.
**Journal complet** : https://github.com/everlier/remotion-bits/compare/vX.Y.(Z-1)...vX.Y.Z
- Faire une pause pour que l'utilisateur publie la release GitHub si une confirmation du navigateur est nécessaire.
6. Déployer la documentation
- Après la publication de la release GitHub, exécuter :
./scripts/deploy-docs.sh
7. Publier sur npm
- Confirmer que l'authentification npm est disponible.
- Publier depuis la racine du dépôt :
npm publish
Règles de décision
- Par défaut, faire des releases patch sauf si l'utilisateur dit le contraire.
- Si les notes de release ne sont pas claires, les dériver de l'historique des commits avant de demander à l'utilisateur.
- Si une commande modifie des artefacts de release, inclure ces changements générés dans le commit de release.
- Si la publication nécessite une étape manuelle dans le navigateur, s'arrêter à la limite, dire exactement à l'utilisateur ce qui l'attend, puis continuer après confirmation.
- Si les identifiants manquent pour GitHub, Cloudflare ou npm, s'arrêter et signaler le prérequis manquant au lieu de réessayer aveuglément.
Checklist de complétion
package.jsona la version cible.CHANGELOG.mda une nouvelle section tout en haut pour cette version.npm run registry:builds'est terminé avec succès.- Le commit de release
chore: vX.Y.Zexiste et est poussé surmaster. - Le formulaire de release GitHub a été ouvert avec les bonnes valeurs préremplies.
- Le déploiement de la documentation est terminé.
npm publishs'est terminé avec succès.