feat: summarize documentation changes in the daily refresh release - #115
Merged
Conversation
Render the build report into release notes listing the added, updated, and removed pages with links, use them for the release body, the commit body, and the job summary, and say explicitly when a run is skipped because nothing changed. Abort the build when the site returns far fewer pages than expected so a broken export cannot ship a gutted index.
Greptile SummaryThe PR adds documentation-refresh reporting, release-note generation, and a minimum-page safeguard.
Confidence Score: 5/5The PR appears safe to merge with no blocking failure remaining. No blocking failure remains. Important Files Changed
Reviews (2): Last reviewed commit: "fix: escape Markdown in release-note pag..." | Re-trigger Greptile |
Titles come from fetched front matter, so neutralize link-breaking characters and percent-encode the path before building the link.
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.
Why
The daily docs refresh released with a fixed one-line note and gave no indication of what changed, and a quiet run left no trace of why it stopped. With #114 making the artifact deterministic, the build now knows exactly which pages were added, updated, or removed, so the release can say so.
What
scripts/build_docs_index.pywrites its JSON report toDOCS_REPORT_FILEin the workflow, and refuses to build when fewer thanDOCS_MIN_PAGES(default 400) pages come back, so a broken site or export cannot ship a gutted index.scripts/docs_release_notes.pyrenders that report into Markdown: page and chunk counts, then Added, Updated, and Removed sections linking each page on appwrite.io.update-docs-index.ymluses the rendered notes as the release body and the commit body, and writes them to the job summary. When the artifact is unchanged the summary says "No changes since the last refresh. Release skipped." and the job exits before committing.What it produces
Release notes and job summary for a day with changes:
Job summary on a quiet day (no commit, no release, no deploy):
## Documentation index No changes since the last refresh. Release skipped.Guard output when the site is broken (job fails, artifact untouched):
Verification
DOCS_MIN_PAGES=100000: exit 1, no artifact written.actionlint.