Feedjoltdocs
Integracions

Esborranys de changelog des de GitHub

Connecta un repositori de GitHub perquè Feedjolt redacti amb IA una entrada de changelog a partir de commits i pull requests fusionades. Tu edites i publiques. Res no es publica sol.

Connecta un repo de GitHub perquè Feedjolt converteixi les fusions de la setmana en un esborrany de changelog orientat al client. Tu edites. Tu publiques.

Els esborranys de changelog des de GitHub són a Startup i Scale (no a Growth) - la mateixa porta que Slack.

Això no és la sincronització de GitHub Issues. Issues continua al full de ruta públic.

Què fa

  • Connecta un repositori per espai de treball amb OAuth de GitHub.
  • Esborrany per finestra - des de l'últim changelog publicat, o un interval de dates (màxim 90 dies).
  • Una sola entrada en esborrany - títol proposat i vinyetes per a clients. No un abocament de commits.
  • Enllaços opcionals a posts - si el títol d'una pull request o un commit encaixa amb un post de feedback, Feedjolt el vincula. No crea un post per commit.
  • Tu publiques - correus i webhooks només en publicar, igual que qualsevol altra entrada.
  • Llista de fonts per a l'equip - l'editor mostra quins commits i pull requests han donat forma a l'esborrany. Els clients no veuen aquesta llista.

Feedjolt no publica sol.

Instal·lar

  1. Obre Panell -> Integracions (/ca/dashboard/integrations).
  2. A la targeta GitHub, prem Connectar GitHub. A Growth veuràs un cadenat i un avís per pujar de pla.
  3. Autoritza el permís d'OAuth. GitHub demana accés repo per poder llegir repositoris privats. Feedjolt només llegeix commits i pull requests.
  4. Tria el repositori del producte que fan servir els teus clients.
  5. Prem Desar repositori.

La pàgina després de l'OAuth és Panell -> Integracions -> GitHub.

Crear l'OAuth App de GitHub (local o autoallotjat)

A Feedjolt allotjat l'app ja existeix. Crea'n una només si executes Feedjolt tu.

Fes servir una OAuth App clàssica, no una GitHub App. Feedjolt truca a https://github.com/login/oauth/authorize.

  1. Entra a GitHub. Obre Developer settings → OAuth Apps (o Settings → Developer settings → OAuth Apps de la teva organització).
  2. Prem New OAuth App.
  3. Omple:
    • Application name — p. ex. Feedjolt local.
    • Homepage URL — l'origen del frontend. En local: http://localhost:3000. En producció: el teu FRONTEND_URL / NEXT_PUBLIC_APP_URL.
    • Authorization callback URL{aquest origen}/auth/github/callback. En local: http://localhost:3000/auth/github/callback. Feedjolt en producció: https://www.feedjolt.com/auth/github/callback. Ha de coincidir amb l'origen del navegador (localhost, no 127.0.0.1; www.feedjolt.com, no l'àpex ni api.feedjolt.com).
  4. Registra l'aplicació. Copia el Client ID.
  5. Prem Generate a new client secret. Copia el secret un cop. GitHub no el torna a mostrar.

Posa els valors a l'entorn (el mateix Client ID als dos fitxers; el secret només al backend):

# backend/.env
GITHUB_CLIENT_ID="Iv1...."
GITHUB_CLIENT_SECRET="...."

# frontend/.env.local  (s'incrusta en arrencar o construir Next)
NEXT_PUBLIC_GITHUB_CLIENT_ID="Iv1...."

Reinicia el backend. Reinicia o reconstrueix el frontend si canvies NEXT_PUBLIC_*. Després connecta a Panell → Integracions → GitHub.

L'app demana l'abast repo per llegir repositoris privats. Feedjolt només llegeix commits i pull requests. Mai no escriu al repo. No cal Device Flow.

Per rotar el secret, genera'n un de nou a la mateixa OAuth App i actualitza GITHUB_CLIENT_SECRET. Els tokens dels espais duren fins que caduquin o algú desconnecti.

Redactar una entrada

  1. Panell -> Changelog -> Esborrany des de GitHub (o Nova entrada i després Esborrany des de GitHub).
  2. Tria Des de l'últim changelog publicat o un interval de dates.
  3. Queda't a la pàgina. Redactar pot tardar un o dos minuts. Feedjolt obre l'Esborrany quan està a punt. No publica.
  4. Edita títol i cos. Activa Vista prèvia per revisar el Markdown. Revisa els posts enllaçats. Mira la llista de fonts de GitHub (només l'equip).
  5. Prem Publicar quan el text estigui a punt.

Si encara no hi ha un changelog publicat, tria un interval. Una finestra buida (sense pull requests fusionades ni commits) no crea res.

Canviar el repositori

No cal desconnectar per canviar de repo.

  1. Panell -> Integracions -> GitHub.
  2. Tria un altre repositori.
  3. Prem Desar repositori.

El següent Esborrany des de GitHub llegeix el repo nou. Els esborranys antics conserven la llista de fonts.

Desconnecta i torna a connectar si necessites un altre compte de GitHub, o si el token ha caducat. Desconnectar talla els esborranys nous. Les entrades de changelog es queden.

Quan Feedjolt llegeix git

Mai amb un calendari. No hi ha webhook, ni un job nocturn, ni un esborrany automàtic en fusionar.

Feedjolt llegeix commits i pull requests fusionades només quan un admin prem Esborrany des de GitHub. Ritme habitual: després d'un llançament, o un cop per setmana.

  • Des de l'últim changelog publicat - tot el que s'ha fusionat després d'aquesta publicació.
  • Interval de dates - les dates que triïs (màxim 90 dies).

Si no hi ha res fusionat en aquesta finestra, no es crea esborrany.

Permisos que demana GitHub

AbastPer a què
repoLlegir commits i pull requests, també en repos privats. L'app OAuth clàssica de GitHub no ofereix un abast de només lectura. Feedjolt no escriu mai al teu repositori.

Desconnecta quan vulguis a Panell -> Integracions -> GitHub -> Desconnectar. Els esborranys de changelog es queden. La llista de fonts d'aquests esborranys també.

Què veuen els clients

El changelog públic, l'RSS, els correus i els webhooks segueixen el camí de publicació de sempre. Els hashes, els números de PR i la llista de fonts no apareixen al portal.

Limitacions

  • Un repo per espai per als esborranys.
  • Només GitHub. Altres sistemes de control de versions queden fora.
  • Sense publicació automàtica. Cal que una persona premi Publicar.
  • No és sync d'Issues. Enllaçar posts de Feedjolt a GitHub Issues és un altre tracker, encara no enviat.

Veure changelog per escriure, programar i RSS.

On this page