Aller au contenu
Commencer gratuitement

Versions

Une annonce de version est une courte page façon blog à partager quand quelque chose sort. Elle vit à une URL qui vous appartient, contient un texte en markdown et peut épingler les éléments de roadmap livrés.

Annonces de version

Chaque projet a un index des versions sur /r/{org}/{project} et une page par version sur :

url
https://opini.dev/r/{org-slug}/{project-slug}/{release-slug}

Rédigez les versions dans le tableau de bord, sous Versions. Chacune a un titre, un texte en markdown, une date de publication facultative et une liste d'éléments à citer par leur nom.

Visibilité

Trois niveaux de visibilité, réglables par version :

  • Publique : listée dans l'index et indexable. Le choix par défaut pour « c'est prêt à lire ».
  • Par lien uniquement : accessible par l'URL directe mais listée nulle part. Idéal pour les lancements discrets, les aperçus partenaires et les changelogs non listés.
  • Privée : réservée aux admins. Pour les brouillons, les post-mortems ou tout ce que les visiteurs ne doivent pas trouver.

Retirer une version ne la supprime pas : passez-la en Privée et l'URL renvoie une 404, le contenu restant intact dans le tableau de bord.

Épingler des éléments

Dans l'éditeur de version, vous pouvez épingler les éléments de roadmap réellement livrés. Les lecteurs voient leurs titres sur la page de la version ; ceux qui affichent leur propre roadmap peuvent récupérer les mêmes informations via l'API publique.

Épingler un élément ne le déplace pas. Les éléments suivent leurs propres colonnes de statut (voir pages publiques) ; les versions sont un récit choisi par-dessus.

Tags sur une version

Les versions peuvent porter des tags : sécurité, breaking, bêta, selon les besoins de votre projet. Les tags s'affichent dans l'index pour que les lecteurs parcourent par type. Voir les tags pour en créer en tapant.

Événements

Deux types d'événements webhook suivent l'état des versions :

  • release.published : déclenché quand une version passe de Privée ou Par lien uniquement à Publique.
  • release.unpublished : déclenché quand une version publique repasse en Privée.

Un usage courant : abonnez une URL de notification à release.published et publiez automatiquement le lien de la version dans votre canal #annonces. Voir les webhooks.