Repository navigation
Publish the changelog as Atom and JSON Feed - #16
Open
bensynapse wants to merge 1 commit into
Open
bensynapse wants to merge 1 commit into
bensynapse wants to merge 1 commit into
Conversation
Developers had no way to follow API changes without re-reading the changelog page. The generator now writes changelog.atom and changelog.json from the same entries as changelog.html, newest first, 50 entries. The changelog page links both in its head and in its header, llms.txt lists them, and --check keeps them current. Truthcheck exempts the feeds for the same reason it exempts the changelog: dated entries quote figures as they stood at the time.
This branch has not been deployed
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
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.
Adds an Atom feed and a JSON Feed of the API changelog, so a developer can follow changes to the spec in a feed reader.
What changes
docs/changelog.atom(Atom 1.0) anddocs/changelog.json(JSON Feed 1.1) are generated byscripts/build_reference.pyfrom the same parsed entries aschangelog.html. They hold the newest 50 entries.changelog.html#v1.13.78.<link rel="alternate">in its head and a "Subscribe in a feed reader" line under the heading.llms.txtlists both feed URLs.--checkcovers the new files, so a changelog edit without regenerating fails CI as before.truthcheck.shexempts the feeds the way it already exempts the changelog: dated entries quote quotas as they stood at the time.Checks
python3 scripts/build_reference.py --checkandsh scripts/truthcheck.shpass.date_publishedin RFC 3339.