Skip to content

data scraper for Changelogs #2949

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions data/changelog/dune/2024-06-17-dune.3.16.0.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Dune 3.16.0
tags: [dune, platform]
versions: [3.16.0, "3.16.0~alpha2", "3.16.0~alpha1"]
changelog: |
### Added

Expand Down
1 change: 1 addition & 0 deletions data/changelog/dune/2024-11-27-dune.3.17.0.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Dune 3.17.0
tags: [dune, platform]
versions: [3.17.0, "3.17.0~alpha0"]
changelog: |
### Fixed

Expand Down
1 change: 1 addition & 0 deletions data/changelog/ocaml-lsp/2024-12-23-ocaml-lsp-1.20.1.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: OCaml-LSP 1.20.1
tags: [ocaml-lsp, platform]
versions: ["1.20.1", "1.20.1-4.14", "1.20.0-4.14"]
changelog: |
## Features
- Add custom `ocamllsp/typeSearch` request ([#1369](https://github.com/ocaml/ocaml-lsp/pull/1369))
Expand Down
1 change: 1 addition & 0 deletions data/changelog/ocaml/2024-05-02-ocaml-5.2.0.rc1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: OCaml 5.2.0 - First Release Candidate
description: First Release Candidate of OCaml 5.2.0
tags: [ocaml]
versions: ["5.2.0-rc1"]
changelog: |
## Changes since the second beta

Expand Down
1 change: 1 addition & 0 deletions data/changelog/ocaml/2024-05-13-ocaml-5.2.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Release of OCaml 5.2.0
description: Release of OCaml 5.2.0
tags: [ocaml]
versions: ["OCaml 5.2.0"]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The versions field is used when the release name doesn't match the changelog file name or to group several releases with one changelog (eg. beta releases)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the policy on prereleases? Do we want to advertise them or hide them? Aren't prerelease for the interested-in only?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think those should be hidden, as few people care about them and they are usually "in the know" anyways.

But perhaps some pre-releases deserve special treatment (e.g. OCaml, dune, opam, etc).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Julow any views on this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find pre-releases quite uninteresting, except perhaps for OCaml and Opam, only when there are no official release that are more recent.
I think the changelog would be better with all the past pre-releases removed.

changelog: |

(Changes that can break existing programs are marked with a "*")
Expand Down
1 change: 1 addition & 0 deletions data/changelog/ocaml/2024-09-20-ocaml-5.3.0.alpha1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: OCaml 5.3.0 - First Alpha
description: First Alpha Release of OCaml 5.3.0
tags: [ocaml]
versions: ["5.3.0-alpha1"]
---

Four months after the release of OCaml 5.2.0, the set of new features for the
Expand Down
1 change: 1 addition & 0 deletions data/changelog/ocaml/2024-10-31-ocaml-5.3.0.beta1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: OCaml 5.3.0 - First Beta
description: First Beta Release of OCaml 5.3.0
tags: [ocaml]
versions: ["5.3.0-beta1"]
changelog: |
### Runtime fixes

Expand Down
1 change: 1 addition & 0 deletions data/changelog/ocaml/2024-11-07-5.2.1-rc1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: OCaml 5.2.1 - Release Candidate
description: Release Candidate for OCaml 5.2.1
tags: [ocaml]
versions: ["5.2.1-rc1"]
changelog: |
## Changes Since OCaml 5.2.0
### Runtime System:
Expand Down
1 change: 1 addition & 0 deletions data/changelog/ocaml/2024-11-18-ocaml-5.2.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Release of OCaml 5.2.1
description: Release of OCaml 5.2.1
tags: [ocaml]
versions: ["OCaml 5.2.1"]
changelog: |

## Changes Since OCaml 5.2.0
Expand Down
1 change: 1 addition & 0 deletions data/changelog/ocaml/2025-01-08-ocaml-5.3.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Release of OCaml 5.3.0
description: Release of OCaml 5.3.0
tags: [ocaml]
versions: ["OCaml 5.3.0"]
changelog: |
(Changes that can break existing programs are marked with a "*")
### Restored backend:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: OCamlFormat 0.24.1
tags: [ocamlformat, platform]
versions: ["0.24.0", "0.24.1"]
changelog: |
### New features

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: OCamlFormat 0.25.1
tags: [ocamlformat, platform]
versions: ["0.25.0", "0.25.1"]
changelog: |
### Library

Expand Down Expand Up @@ -171,4 +172,4 @@ The OCamlFormat team
+ else if Sys.unix then (module Unix)
+ else (module Fail)
+ : Unix_socket)
```
```
130 changes: 130 additions & 0 deletions data/changelog/ocamlformat/2024-12-02-ocamlformat-0.27.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
---
title: OCamlformat 0.27.0
tags: [ocamlformat, platform]
changelog: |
### Highlight

- \* Support OCaml 5.2 syntax (#2519, #2544, #2590, #2596, #2621, #2628, @Julow, @EmileTrotignon, @hhugo)
This includes local open in types, raw identifiers, and the new
representation for functions.
This might change the formatting of some functions due to the formatting code
being completely rewritten.

- Support OCaml 5.3 syntax (#2609, #2610, #2611, #2622, #2623, #2562, #2624, #2625, #2627, @Julow, @Zeta611)
This adds support for effect patterns, short functor type arguments and utf8
identifiers.
To format code using the new `effect` syntax, add this option to your
`.ocamlformat`:
```
ocaml-version = 5.3
```

- Documentation comments are now formatted by default (#2390, @Julow)
Use the option `parse-docstrings = false` to restore the previous behavior.

- \* Consistent indentation of polymorphic variant arguments (#2427, @Julow)
Increases the indentation by one to make the formatting consistent with
normal variants. For example:
```
...
(* before *)
(`Msg
(foo bar))
(* after *)
(`Msg
(foo bar))
```

- Build on OCaml 5.3 (#2603, @adamchol, @Julow)

### Added

- Improve the emacs plugin (#2577, #2600, @gridbugs, @thibautbenjamin)
Allow a custom command to be used to run ocamlformat and add compatibility
with emacs ocaml tree-sitter modes.

- Added option `let-binding-deindent-fun` (#2521, @henrytill)
to control the indentation of the `fun` in:
```
let f =
fun foo ->
bar
```

- Added back the flag `--disable-outside-detected-project` (#2439, @gpetiot)
It was removed in version 0.22.

- Support newer Odoc syntax (#2631, #2632, #2633, @Julow)

### Changed

- \* Consistent formatting of comments (#2371, #2550, @Julow)
This is mostly an internal change but some comments might be formatted differently.

- \* Improve formatting of type constraints with type variables (#2437, @gpetiot)
For example:
```
let f : type a b c.
a -> b -> c =
...
```

- \* Improve formatting of functor arguments (#2505, @Julow)
This also reduce the indentation of functor arguments with long signatures.

- Improvements to the Janestreet profile (#2445, #2314, #2460, #2593, #2612, @Julow, @tdelvecchio-jsc)

- \* Undo let-bindings and methods normalizations (#2523, #2529, @gpetiot)
This remove the rewriting of some forms of let-bindings and methods:
+ `let f x = (x : int)` is no longer rewritten into `let f x : int = x`
+ `let f (type a) (type b) ...` is no longer rewritten into `let f (type a b) ...`
+ `let f = fun x -> ...` is no longer rewritten into `let f x = ...`

- \* The `break-colon` option is now taken into account for method type constraints (#2529, @gpetiot)

- \* Force a break around comments following an infix operator (fix non-stabilizing comments) (#2478, @gpetiot)
This adds a line break:
```
a
||
(* this comment is now on its own line *)
b
```

### Fixed

- Fix placement of comments in some cases (#2471, #2503, #2506, #2540, #2541, #2592, #2617, @gpetiot, @Julow)
Some comments were being moved or causing OCamlformat to crash.
OCamlformat refuses to format if a comment would be missing in its output, to avoid loosing code.

- Fix attributes being dropped or moved (#2247, #2459, #2551, #2564, #2602, @EmileTrotignon, @tdelvecchio-jsc, @Julow)
OCamlformat refuses to format if the formatted code has a different meaning than the original code, for example, if an attribute is removed.
We also try to avoid moving attributes even if that doesn't change the original code, for example we no longer format `open[@attr] M` as `open M [@@attr]`.

- Remove trailing space inside a wrapping empty signature (#2443, @Julow)
- Fix extension-point spacing in structures (#2450, @Julow)
- \* Consistent break after string constant argument (#2453, @Julow)
- \* Fix cinaps comment formatting to not change multiline string contents (#2463, @tdelvecchio-jsc)
- \* Fix the indentation of tuples in attributes and extensions (#2488, @Julow)
- \* Fix weird indentation and line breaks after comments (#2507, #2589, #2606, @Julow)
- \* Fix unwanted alignment in if-then-else (#2511, @Julow)
- Fix missing parentheses around constraint expressions with attributes (#2513, @alanechang)
- Fix formatting of type vars in GADT constructors (#2518, @Julow)
- Fix `[@ocamlformat "disable"]` in some cases (#2242, #2525, @EmileTrotignon)
This caused a bug inside `class type` constructs and when attached to a `let ... in`
- Display `a##b` instead of `a ## b` and similarly for operators that start with # (#2580, @v-gb)
- \* Fix arrow type indentation with `break-separators=before` (#2598, @Julow)
- Fix missing parentheses around a let in class expressions (#2599, @Julow)
- Fix formatting of paragraphs in lists in documentation (#2607, @Julow)
- Avoid unwanted space in references and links text in documentation (#2608, @Julow)
- \* Improve the indentation of attributes in patterns (#2613, @Julow)
- \* Avoid large indentation in patterns after `let%ext` (#2615, @Julow)
---

After almost a year of work, OCamlformat 0.27.0 is finally available with
support for 5.3 syntax!

This release includes the new function syntax from OCaml 5.2, the `effect`
keyword from OCaml 5.3 and a large number of bug fixes and improvements.

An other notable change, is that comments are now formatted by default.
1 change: 1 addition & 0 deletions data/changelog/omp/2020-04-15-omp-1.7.1.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Omp ocaml-migrate-parsetree-1.7.1
tags: [omp]
versions: ["v1.7.1"]
changelog: |
- Fix build with OCaml < 4.08

Expand Down
1 change: 1 addition & 0 deletions data/changelog/omp/2020-04-20-omp-1.7.2.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Omp ocaml-migrate-parsetree-1.7.2
tags: [omp]
versions: ["v1.7.2"]
changelog: |
- Remove toplevel `Option` module accidentally added in 1.7.0
---
Expand Down
1 change: 1 addition & 0 deletions data/changelog/omp/2020-05-07-omp-1.7.3.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Omp ocaml-migrate-parsetree-1.7.3
tags: [omp]
versions: ["v1.7.3"]
changelog: |
- Fix magic numbers for the 4.11 ast (#96, @hhugo)
---
Expand Down
1 change: 1 addition & 0 deletions data/changelog/omp/2020-08-12-omp-2.0.0.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Omp ocaml-migrate-parsetree-2.0.0
tags: [omp]
versions: ["v2.0.0"]
changelog: |
- No longer expose the unwrapped modules (#94, @jonludlam)
- Remove everything but Ast versions and upgrade/downgrade
Expand Down
1 change: 1 addition & 0 deletions data/changelog/omp/2020-10-22-omp-2.1.0.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Omp ocaml-migrate-parsetree-2.1.0
tags: [omp]
versions: ["v2.1.0"]
changelog: |
- Add support for 4.12 (#107, @ceastlund)
---
Expand Down
1 change: 1 addition & 0 deletions data/changelog/omp/2020-10-23-omp-1.8.0.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Omp ocaml-migrate-parsetree-1.8.0
tags: [omp]
versions: ["v1.8.0"]
changelog: |
Oops, we went looking but didn't find the changelog for this release 🙈
---
1 change: 1 addition & 0 deletions data/changelog/omp/2021-06-22-omp-2.2.0.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Omp ocaml-migrate-parsetree-2.2.0
tags: [omp]
versions: ["v2.2.0"]
changelog: |
- Add support for 4.13 (#114, @kit-ty-kate)
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Opam-publish 2.0.0
tags: [opam-publish, platform]
versions: ["2.0.0", "2.0.0: Merge pull request #66 from rjbou/push-on-master"]
changelog: |
* Switch default branch from 2.0.0 to master
* Minor fix
Expand Down
1 change: 1 addition & 0 deletions data/changelog/opam/2024-05-22-opam-2-1-6.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: opam 2.1.5
authors: [ "Raja Boujbel" ]
versions: ["2.1.6"]
description: "Release of opam 2.1.5"
tags: [opam, platform]
changelog: |
Expand Down
1 change: 1 addition & 0 deletions data/changelog/opam/2024-06-10-opam-2-2-0-beta3.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ authors: [
"Kate Deplaix",
"David Allsopp",
]
versions: ["2.2.0~beta3"]
description: "Beta3 release of opam 2.2.0"
tags: [opam, platform]
---
Expand Down
1 change: 1 addition & 0 deletions data/changelog/opam/2024-06-21-opam-2-2-0-rc1.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ authors: [
"Kate Deplaix",
"David Allsopp",
]
versions: ["2.2.0~rc1"]
description: "RC1 release of opam 2.2.0"
tags: [opam, platform]
---
Expand Down
1 change: 1 addition & 0 deletions data/changelog/opam/2024-07-01-opam-2-2-0.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ authors: [
"Kate Deplaix",
"David Allsopp",
]
versions: ["2.2.0"]
description: "Release of opam 2.2.0"
tags: [opam, platform]
---
Expand Down
1 change: 1 addition & 0 deletions data/changelog/opam/2024-08-22-opam-2-2-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ authors: [
"Kate Deplaix",
"David Allsopp",
]
versions: ["2.2.1"]
description: "opam 2.2.1 release"
tags: [opam, platform]
---
Expand Down
1 change: 1 addition & 0 deletions data/changelog/opam/2024-09-19-opam-2-3-0-alpha1.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ authors: [
"Kate Deplaix",
"David Allsopp",
]
versions: ["2.3.0~alpha1"]
description: "Release of opam 2.3.0~alpha1"
tags: [opam, platform]
---
Expand Down
1 change: 1 addition & 0 deletions data/changelog/opam/2024-10-15-opam-2-3-0-beta1.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ authors: [
"Kate Deplaix",
"David Allsopp",
]
versions: ["2.3.0~beta1"]
description: "Release of opam 2.3.0~beta1"
tags: [opam, platform]
---
Expand Down
1 change: 1 addition & 0 deletions data/changelog/opam/2024-10-24-opam-2-3-0-beta2.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ authors: [
"Kate Deplaix",
"David Allsopp",
]
versions: ["2.3.0~beta2"]
description: "Release of opam 2.3.0~beta2"
tags: [opam, platform]
---
Expand Down
1 change: 1 addition & 0 deletions data/changelog/opam/2024-10-30-opam-2-3-0-rc1.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ authors: [
"Kate Deplaix",
"David Allsopp",
]
versions: ["2.3.0~rc1"]
description: "Release of opam 2.3.0~rc1"
tags: [opam, platform]
---
Expand Down
1 change: 1 addition & 0 deletions data/changelog/opam/2024-11-13-opam-2-3-0.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ authors: [
"Kate Deplaix",
"David Allsopp",
]
versions: ["2.3.0"]
description: "Release of opam 2.3.0"
tags: [opam, platform]
---
Expand Down
2 changes: 2 additions & 0 deletions src/ocamlorg_data/data_intf.ml
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,8 @@ module Changelog = struct
body_html : string;
body : string;
authors : string list;
project_name : string;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

project_name is parsed from the slug.

versions : string list;
}
[@@deriving of_yaml, show]
end
Expand Down
Loading
Loading