Mergerie
Sommaire

Les événements

Cette page est générée depuis docs/plugins/EVENTS.md · Modifier cette page sur GitLab

Généré depuis sdk/contract.js (API 1) par sdk/scripts/generer-docs-events.js — ne pas éditer à la main.

Un événement est un nom (domaine.action) et un payload sérialisable qui porte toujours version. Les handlers tournent en file, chacun sous try/catch et délai (30 s) : un abonné qui échoue est journalisé, jamais propagé. Un plugin s’abonne avec ctx.events.on(name, handler) et émet les siens (déclarés dans plugin.json → events.emits) avec ctx.events.emit(name, payload).

ÉvénementVersionSourceQuand
app.ready1cœurle serveur écoute et les plugins sont activés
app.shutdown1cœurle serveur s’arrête (avant la désactivation des plugins)
repo.deleted1cœurun dépôt suivi est retiré de Réglages → Dépôts
session.started1cœurune session (codage, exploration, hors dépôt, question) commence à tourner
session.finished1cœurune session a fini de tourner (succès, erreur, arrêt, question posée)
mr.created1cœurune merge request devient connue de Mergerie (découverte sur la forge)
review.completed1cœurun rapport de review est enregistré
converge.finished1cœurune boucle de convergence s’arrête
verify.finished1cœurune vérification objective a rendu son verdict (ou échoué)
jenkins.job.started1plugin jenkinsun build démarre : lancé depuis Mergerie, ou — si « Annoncer tous les jobs » est coché dans le plugin — lancé par n’importe qui
jenkins.job.finished1plugin jenkinsun build s’est terminé : lancé depuis Mergerie, ou — si « Annoncer tous les jobs » est coché dans le plugin — lancé par n’importe qui

app.ready

Quand : le serveur écoute et les plugins sont activés. Source : cœur. Version : 1.

ChampType
portnumber
hoststring
demoboolean
{
  "version": 1,
  "port": 42,
  "host": "host-example",
  "demo": true
}

app.shutdown

Quand : le serveur s’arrête (avant la désactivation des plugins). Source : cœur. Version : 1.

(aucun champ en dehors de version)

{
  "version": 1
}

repo.deleted

Quand : un dépôt suivi est retiré de Réglages → Dépôts. Source : cœur. Version : 1.

ChampType
idnumber
projectstring
{
  "version": 1,
  "id": 42,
  "project": "project-example"
}

session.started

Quand : une session (codage, exploration, hors dépôt, question) commence à tourner. Source : cœur. Version : 1.

ChampType
kind`"task"
idnumber
actionstring
{
  "version": 1,
  "kind": "task",
  "id": 42,
  "action": "action-example"
}

session.finished

Quand : une session a fini de tourner (succès, erreur, arrêt, question posée). Source : cœur. Version : 1.

ChampType
kind`"task"
idnumber
actionstring
status`"done"
{
  "version": 1,
  "kind": "task",
  "id": 42,
  "action": "action-example",
  "status": "done"
}

mr.created

Quand : une merge request devient connue de Mergerie (découverte sur la forge). Source : cœur. Version : 1.

ChampType
mr_idnumber
iidnumber
projectstring
titlestring
{
  "version": 1,
  "mr_id": 42,
  "iid": 42,
  "project": "project-example",
  "title": "title-example"
}

review.completed

Quand : un rapport de review est enregistré. Source : cœur. Version : 1.

ChampType
mr_idnumber
iidnumber
note10`number
{
  "version": 1,
  "mr_id": 42,
  "iid": 42,
  "note10": 42
}

converge.finished

Quand : une boucle de convergence s’arrête. Source : cœur. Version : 1.

ChampType
mr_idnumber
iidnumber
statusstring
note10`number
passesnumber
{
  "version": 1,
  "mr_id": 42,
  "iid": 42,
  "status": "status-example",
  "note10": 42,
  "passes": 42
}

verify.finished

Quand : une vérification objective a rendu son verdict (ou échoué). Source : cœur. Version : 1.

ChampType
verification_idnumber
verdictstring
{
  "version": 1,
  "verification_id": 42,
  "verdict": "verdict-example"
}

jenkins.job.started

Quand : un build démarre : lancé depuis Mergerie, ou — si « Annoncer tous les jobs » est coché dans le plugin — lancé par n’importe qui. Source : plugin jenkins. Version : 1.

ChampType
source`"mergerie"
pathstring
sincenumber
parametersRecord<string, string>
urlstring
startedBystring
{
  "version": 1,
  "source": "mergerie",
  "path": "path-example",
  "since": 42,
  "parameters": {
    "BRANCH": "main"
  },
  "url": "url-example",
  "startedBy": "startedBy-example"
}

jenkins.job.finished

Quand : un build s’est terminé : lancé depuis Mergerie, ou — si « Annoncer tous les jobs » est coché dans le plugin — lancé par n’importe qui. Source : plugin jenkins. Version : 1.

ChampType
source`"mergerie"
pathstring
numbernumber
resultstring
okboolean
urlstring
durationnumber
startedBystring
parametersRecord<string, string>
{
  "version": 1,
  "source": "mergerie",
  "path": "path-example",
  "number": 42,
  "result": "result-example",
  "ok": true,
  "url": "url-example",
  "duration": 42,
  "startedBy": "startedBy-example",
  "parameters": {
    "BRANCH": "main"
  }
}

Compatibilité

Un champ ajouté au payload ne change pas la version. Un champ retiré ou renommé, ou un sens qui change, incrémente version : le plugin lit payload.version et sait à quoi s’attendre. Voir MIGRATION.md.