(data) Add platform release changelogs#3641
Open
sabine wants to merge 11 commits into
Open
Conversation
Includes the OCaml 5.5.0-beta1 announcement (copied from discuss), plus drafts (with PR-linked summaries) for dune-release 2.2.1, mdx 2.5.2, merlin v5.7-505_preview and v5.7.1-504, ocaml-lsp 1.26.0-5.5_preview, ocamlformat 0.29.0, odoc 3.2.0, opam-publish 3.0.0, and utop 2.17.0. Also marks the unreleased OCaml 5.5.0-alpha2 draft as ignore: true and backfills the github_release_tags field on the existing merlin 5.7.0-504 file so the scraper recognizes it. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- odoc 3.2.0: the multiple-input markdown-generate change is PR ocaml#1388 (the upstream release notes mistakenly cited ocaml#1387, which is just a CLI help-section reclassification). - ocamlformat 0.29.0: move the upstream "### Highlight" section out of the YAML changelog and merge its content into the announcement body, so the YAML stays focused on the per-section change list. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…body Keep the upstream Highlight section in the YAML but strip out the multi-line code examples so the changelog stays compact. The same examples are now shown in the announcement body, where they are more visible to readers. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
For releases that summarised multiple distinct changes in a single prose paragraph (merlin previews/patches, ocaml-lsp preview, odoc, opam-publish, utop, ocamlformat), break the items out as a bullet list under a short lead-in. Easier to scan than a wall of prose. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The discuss.ocaml.org markdown for the beta1 announcement triggered several lint rules: mixed setext/ATX headings, bare URLs, asterisk list markers, and runs of consecutive blank lines. Convert to consistent ATX headings, dash list markers, autolinks (<URL>), and single blank-line spacing. Wording is unchanged. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Both releases were dated 2026-10-04 (a date typo); the actual release date per the discuss.ocaml.org announcement and GitHub tag is around April 9-10, 2026. Renaming so the URL slugs reflect reality. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Julow
reviewed
May 7, 2026
| | () -> begin | ||
| match () with | ||
| | () -> () | ||
| ``` |
| - The default `ocaml-version` is now 5.4 ([#2750](https://github.com/ocaml-ppx/ocamlformat/pull/2750)), so the `effect` keyword is recognized without extra configuration (code that uses `effect` as an identifier must set `ocaml-version=5.2`). | ||
| - A new `letop-punning` option (`preserve` by default) controls whether bindings like `let+ x = x in ...` are punned to `let+ x in ...` ([#2746](https://github.com/ocaml-ppx/ocamlformat/pull/2746), [#2747](https://github.com/ocaml-ppx/ocamlformat/pull/2747)). | ||
|
|
||
| ### Formatting examples |
Contributor
There was a problem hiding this comment.
This section is less accurate than the changelog. I suggest to remove it entirely. People can read the full changelog quickly from here and don't need an AI summary.
Collaborator
Author
There was a problem hiding this comment.
The maintainers are announcing on discuss.ocaml.org the releases. Maybe write the announcement before it comes to this stop-gap measure of somehow getting a release announcement when there isn't one?
In an ideal world either the maintainer publishes a release announcement here or on discuss.ocaml.org (or both). Or the GitHub release has a release announcement that's worth distributing to the general public.
Contributor
There was a problem hiding this comment.
The "Highlight" section of the changelog is meant to be that! It's on Github too: https://github.com/ocaml-ppx/ocamlformat/releases/tag/0.29.0
Collaborator
Author
There was a problem hiding this comment.
Oh okay. Sorry that wasn't obvious. If you could just go and make the discuss announcement together with the release that would help a ton in terms of what to put here.
Leonidas-from-XIV
approved these changes
May 7, 2026
Contributor
Leonidas-from-XIV
left a comment
Leonidas-from-XIV
left a comment
There was a problem hiding this comment.
Looks ok from a dune-release.2.2.1 perspective; that was entirely the point of the release. I haven't checked the other packages.
Co-authored-by: Jules Aguillon <jules@j3s.fr>
- mdx 2.5.2: simplify body wording per Julow's suggestion (drop the Env_functor_arg/Env_not_aliasable technical detail). - ocamlformat 0.29.0: drop the "Highlights of this release" prose summary as Julow recommends — the changelog itself is more accurate and immediately below. Fix the mangled "indentation of the `end` keyword" code example: the upstream CHANGES.md has an unclosed "after" block; rebuild it from PR ocaml#2742's description so the inner `end` appears at indent 2. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Per discussion on PR ocaml#3641, replace the curated body (Highlights bullet list + Formatting examples) with the verbatim text of the GitHub release notes, prefixed only with a "We're happy to announce" line. Two format-only fixes applied to make the file pass markdownlint: - nested `+` bullets converted to `-` (renders identically); - trailing blank line removed. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The body already contains the verbatim GitHub release notes, so the YAML `changelog:` field is no longer needed and was duplicating the content. Set it to empty so only the body renders. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hi everyone,
this PR adds draft release announcements for several platform tools that were published over the last few months but didn't have entries on ocaml.org yet.
The bodies are short summaries grounded in the linked PRs.
Could you each take a quick look at your release(s) below to confirm the descriptions are accurate (or suggest corrections), and feel free to improve the wording / add detail directly?
You're also encouraged to publish the announcement on discuss.ocaml.org if you haven't already. Once a discuss thread exists we can link to it from the page.
dune-release 2.2.1mdx 2.5.2,ocamlformat 0.29.0merlin v5.7-505~preview,merlin v5.7.1-504,ocaml-lsp 1.26.0-5.5~previewocaml 5.5.0~beta1,utop 2.17.0odoc 3.2.0opam-publish 3.0.0The OCaml 5.5.0~beta1 page is copied verbatim from the corresponding post on discuss.ocaml.org; the others are short summaries written from the GitHub release notes and PR descriptions.
@jonludlam / @panglesd: the upstream odoc 3.2.0 release notes attribute the "markdown-generate accepts multiple .odocl files" change to ocaml/odoc#1387, but ocaml/odoc#1387 is just a CLI help-section reclassification. The actual multi-input change seems to be ocaml/odoc#1388. The draft here uses ocaml/odoc#1388; you may want to fix the upstream release notes.
Thanks!