Repository navigation
Point the changelog page at the corrections log - #30
Merged
Merged
Conversation
The changelog page lists changes to the specification. Corrections to published data values now have their own page on livetennisapi.com. A second paragraph in the page header links it. The header is written in build_changelog. The text above the first entry in CHANGELOG.md is not rendered, so the line goes in the template. docs/changelog.html is rebuilt and nothing else changed. There is no changelog entry or version bump, as with the earlier docs-only changes to the page template.
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.
The docs changelog lists changes to the specification. Corrections to published data values are a different thing. They now have their own page, the corrections log at https://livetennisapi.com/data/corrections.
This adds one paragraph to the changelog page header that links it:
Where it goes
build_changeloginscripts/build_reference.pywrites the page header. The text above the first## [x.y.z]heading in CHANGELOG.md is never rendered, so the line goes in the template, right after the existing header paragraph.docs/changelog.htmlis rebuilt. No other generated file changed.There is no changelog entry and no version bump. Earlier docs-only changes to the templates did the same, such as the footer credit in #8.
Merge order
The corrections log is added by tennisv1 #140, which is not deployed yet. Until it is, the URL redirects to the homepage. Please merge this after tennisv1 #140 is live and /data/corrections returns 200.
Checks
python scripts/build_reference.py --check: generated docs are currentsh scripts/truthcheck.sh: OKnpx @redocly/cli@latest lint openapi.yaml: validpython -m unittest scripts/test_build_code_samples.py: 19 tests OKpython scripts/check_client_versions.py: 15 of 15 rows match