Skip to content

fix: show every version's release notes on the changelog and complete the landing page - #81

Merged
enimaloc merged 3 commits into
devfrom
fix/changelog-generation
Nov 1, 2026
Merged

enimaloc merged 3 commits into
devfrom
fix/changelog-generation

Conversation

@enimaloc

@enimaloc enimaloc commented Oct 31, 2026 •

Copy link
Copy Markdown
Owner

Résumé

/changelog n'affichait qu'une seule ligne ((release) v1.0.0-BETA.99), car git log tournait sur un clone à un seul commit dans le build de l'image.

La page affiche maintenant les notes de release de toutes les versions :

  • Version en cours de publication : notes de sa PR de release, modifications à la main comprises.
  • Versions déjà publiées : notes de leur GitHub Release. Une correction faite après publication apparaît à la release suivante.
  • Versions sans notes : elles restent listées, avec une mention traduite.
  • Si GitHub ne répond pas au build : la release continue et la page s'arrête à la dernière version de CHANGELOG.md.

ChangelogService lit un seul fichier, changelog.md, généré au build. En local, c'est une copie de CHANGELOG.md. Le premier commit de la PR (titres de PR et historique git) est remplacé par ce fonctionnement.

Landing page

Les cartes Minecraft, Steam et Xbox affichaient ??platforms.*.description_fr_FR?? : les clés n'existaient dans aucune langue. Elles sont ajoutées, et SiteCatalogTest vérifie les textes des cartes dans chaque langue.

Limites

  • Les notes s'affichent telles qu'écrites, donc en anglais et avec les lignes « merge … into dev » tant qu'elles ne sont pas retouchées.
  • Le Markdown en ligne (liens, code) s'affiche brut.
  • La date de sortie n'est pas affichée.

Modules à redémarrer

catapult-api et catapult-web

Tests

ChangelogServiceTest, ChangelogControllerTest, SiteCatalogTest et les tests des scripts de release passent. Le script a tourné sur les 100 vraies releases avec des notes de test. englishConventions échoue à cause de commentaires français dans catapult-web-old, sans rapport avec cette PR. Le job de release lui-même n'a pas été exécuté.

The release image was built from a shallow clone, so the page only listed the release commit.
The image now gets the full history, and each tag's range lists its merged pull requests by title.
Their keys existed in no language, so the page showed the raw ??key?? markers.
@enimaloc enimaloc changed the title fix(api): build the changelog from every version's merged pull requests fix: build the changelog from merged pull requests and complete the landing page Nov 1, 2026
The page now reads the notes edited in the release PR and on the GitHub Releases, not PR titles.
Older versions stay listed, including those published without notes.
@enimaloc enimaloc changed the title fix: build the changelog from merged pull requests and complete the landing page fix: show every version's release notes on the changelog and complete the landing page Nov 1, 2026
@enimaloc
enimaloc merged commit a82d8d8 into dev Nov 1, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant