data scraper for Changelogs #2949
Draft
Conversation
This file contains 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
This field stores the project's name and version string parsed from the file path and the slug.
This scraper doesn't generate changelog entries, instead it exits with an error when one is missing. The intention is to be notified when a changelog is missing.
Release names can be different on Github, which triggers false positives. The new 'versions' field in changelogs can be used to specify the release name on Github and to associate several releases with one changelog.
Julow
commented
Feb 6, 2025
| @@ -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"] | |||
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
What's the policy on prereleases? Do we want to advertise them or hide them? Aren't prerelease for the interested-in only?
| @@ -129,6 +129,8 @@ module Changelog = struct | |||
| body_html : string; | |||
| body : string; | |||
| authors : string list; | |||
| project_name : string; | |||
There was a problem hiding this comment.
project_name is parsed from the slug.
|
Thanks @Julow, that's great. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This adds a tool that detects missing changelogs by looking at projects' release pages. My intention is to write a GA that will notify maintainers (perhaps by opening draft PRs) for new releases.
Does that sound good ?
This will not help catching new releases in its current form but it can be used to add changelogs that are already missing. Here's its output: