Publier des modifications
Publiez des modifications depuis l'éditeur vers votre site publié. Les branches et les règles de protection déterminent ce qui se passe lorsque vous publiez.
Vos modifications sont enregistrées automatiquement pendant que vous travaillez, mais elles n’atteignent votre site publié que lorsque vous les publiez. Ce qui se passe lorsque vous publiez dépend de la branch sur laquelle vous travaillez et du fait que cette branch soit protégée ou non.
S’il n’y a pas de bouton Publish dans la barre d’outils de votre éditeur, la publication automatique est activée sur votre deployment et vos modifications sont mises en ligne automatiquement.
S’il n’y a pas de sélecteur de branch, affichez le sélecteur de branch.
Si vous ne voyez que vos propres modifications dans le menu Publish, activez la publication granulaire pour voir les modifications de tout le monde.
Sur votre deployment branch, l’éditeur considère les éléments suivants comme des modifications en attente jusqu’à ce que vous les publiiez :
- Les modifications de contenu dans les pages
- Les pages ajoutées ou supprimées
- Les changements de structure de navigation
- Les médias téléversés
- Les mises à jour de configuration
Cliquez sur Publish dans la barre d’outils pour voir vos modifications en attente. Cliquez sur n’importe quel fichier modifié pour le comparer à la version publiée.
| Type de branch | Protection de branch | Actions disponibles |
|---|---|---|
| Deployment branch | Aucune | Publish directement vers votre site publié |
| Deployment branch | Pull requests requises | Create branch pour déplacer votre travail vers une nouvelle branch |
| Feature branch | Aucune | Request review, puis Merge and publish |
| Feature branch | Protégée | Create branch pour continuer à modifier sur une nouvelle branch |
- Publish : Commit vos modifications en attente sur votre deployment branch et les déploie sur votre site publié.
- Request review : Marque la pull request de la branch comme prête à être relue.
- Merge and publish : Fusionne la pull request dans votre deployment branch et la déploie. Disponible dès que la pull request est prête ou approuvée, selon les exigences de relecture de votre dépôt.
- Create branch : Crée une nouvelle feature branch lorsque vous ne pouvez pas publier sur la branch actuelle.
Une seule publication peut avoir lieu à la fois par branch. Si un collègue publie sur la même branch, attendez la fin de sa publication avant de réessayer.
Votre site est mis à jour une fois que Mintlify a compilé et déployé vos modifications. Cela prend généralement de 30 secondes à quelques minutes. Consultez l’état du déploiement sur votre dashboard.
Si une page de votre branch comporte un MDX non valide, l’éditeur désactive les boutons Publish et Request review jusqu’à ce que vous le corrigiez. Survolez Publish pour voir combien de pages ont des erreurs, puis ouvrez chaque page en mode source pour repérer et corriger l’erreur. Consultez Bouton Publish désactivé à cause d’un MDX non valide pour plus de détails.
Lorsque plusieurs personnes ont des modifications en attente sur votre deployment branch, le paramètre Granular publishing contrôle quelles modifications le menu Publish affiche.
Publication granulaire désactivée (par défaut) : Le menu Publish n’affiche que vos modifications. Cela comprend les fichiers que vous avez modifiés, les fichiers modifiés à la fois par vous et vos collègues, ainsi que les fichiers sans auteur enregistré. Publish et Discard all ne s’appliquent qu’à ces modifications. Si vos collègues ont d’autres modifications en attente, un avis indique que leurs modifications sont masquées.
Publication granulaire activée : Le menu Publish répartit les modifications en attente entre Your changes et Modified by others. Vos modifications sont sélectionnées par défaut, tandis que celles des autres ne le sont pas. Utilisez les cases à cocher pour choisir les modifications à publier. Chaque section dispose de son propre bouton Discard.
Une icône de contributeurs marque les fichiers modifiés par une autre personne que vous. Survolez-la pour voir qui a modifié le fichier.
- La publication granulaire ne s’applique que sur une deployment branch sans protections de branch. Sur les feature branches, la publication inclut toutes les modifications en attente.
- Supprimer un dossier supprime toutes les pages qu’il contient. Ces suppressions sont publiées ensemble. Vous ne pouvez pas supprimer partiellement un dossier.
- Certaines modifications dépendent les unes des autres, comme une page et son entrée de navigation. Si votre sélection omet une modification dont dépend une modification sélectionnée, la publication échoue avec une erreur. Ajustez votre sélection pour inclure la dépendance, puis publiez à nouveau.
Modifiez directement sur votre deployment branch si vous n’utilisez pas de workflow de révision. Créez une branch si chaque modification passe par une révision avant d’atteindre votre site publié.
Pour créer une branch :
- Cliquez sur le nom de la branch dans la barre d’outils de l’éditeur. Sur votre deployment branch, le nom comporte un badge Live.
- Vous pouvez saisir un titre pour votre branch dans Find a branch.
- Cliquez sur New branch.
Si vous ne saisissez pas de titre, l’éditeur nomme la branch d’après la date actuelle. Si vous avez des modifications en attente au moment où vous créez une branch, l’éditeur vous demande si vous voulez Bring them to this branch ou Leave them behind. Votre branch d’origine conserve ses modifications en attente dans les deux cas.
Les modifications effectuées sur une branch que vous avez créée dans l’éditeur sont commitées automatiquement sur la branch, environ 15 secondes après que vous arrêtez d’écrire. Le premier commit ouvre une pull request vers votre deployment branch. La pull request s’ouvre en brouillon si Create draft pull requests by default est activé.
Lorsque vos modifications sont prêtes, cliquez sur Publish, puis sur Request review. Une fois que votre pull request répond aux exigences de relecture de votre dépôt, cliquez sur Merge and publish. L’éditeur fusionne la pull request et vous ramène sur votre deployment branch.
Le menu des branches liste votre deployment branch et les branches ayant une pull request ouverte, y compris les pull requests ouvertes en dehors de l’éditeur. Chaque branch affiche l’état de sa pull request. Pour trouver une branch fusionnée ou fermée, recherchez-la par son nom.
Pour renommer ou supprimer une branch, survolez-la dans le menu des branches et cliquez sur Rename branch ou Delete branch. Supprimer une branch la retire définitivement de votre dépôt, ainsi que toutes les modifications non publiées qu’elle contient.
Si votre deployment branch n’a pas de protections de branch, l’éditeur masque le sélecteur de branch lorsque vous travaillez sur la deployment branch. Pour l’afficher, cliquez sur More options dans la barre supérieure, puis activez Branches. Cette préférence ne s’applique qu’à vous.
Le sélecteur de branch apparaît toujours lorsque votre deployment branch a des protections de branch ou lorsque vous travaillez sur une feature branch.
Lorsque quelqu’un pousse des modifications vers votre dépôt en dehors de l’éditeur, l’éditeur fusionne ses modifications dans les pages que vous avez ouvertes. Une notification vous indique combien de mises à jour ont été appliquées.
Si une modification distante et la vôtre portent sur la même partie d’une page, l’éditeur conserve les deux versions et les met en évidence. Passez en revue le contenu mis en évidence, conservez la version que vous souhaitez et supprimez l’autre.
Signez vos commits avec votre compte GitHub en l’autorisant dans les paramètres de votre compte. Sans cette autorisation, la GitHub App de Mintlify signe les commits effectués dans l’éditeur.
Si la publication automatique est activée sur votre deployment, l’éditeur commit sur votre deployment branch peu après que vous arrêtez d’écrire. Le sélecteur de branch et le bouton Publish sont masqués. Il n’y a ni état en attente ni étape de révision.