fix: skip GLRD releases not yet published on GitHub#103
Merged
Conversation
Add centralized GitHub HTTP client for docs aggregation: - New github_api module with get_json and list_repo_releases - Authentication via GITHUB_TOKEN environment variable - Rate limit detection and actionable error messages - Comprehensive unit tests for API client - Unit tests for GLRD release filtering against GitHub tags Signed-off-by: Eike Waldt <waldt@b1-systems.de> On-behalf-of: SAP <eike.waldt@sap.com> Assisted-by: Kilo:claude-opus-4-7 Assisted-by: Kilo:claude-sonnet-4-6
Refactor release documentation generation to avoid duplicate API calls: - Fetch GitHub releases once in aggregate.py before generators run - Pass pre-fetched release list to both generators - Filter GLRD release tables to only show releases with GitHub tags - Remove curl-based GitHub fetching from release_notes.py - Add existing_gh_tags parameter to generate_release_docs - Write warnings to stderr for GLRD releases missing GitHub tags - Hard-fail early on GitHub API errors with actionable hint Signed-off-by: Eike Waldt <waldt@b1-systems.de> On-behalf-of: SAP <eike.waldt@sap.com> Assisted-by: Kilo:claude-opus-4-7 Assisted-by: Kilo:claude-sonnet-4-6
- Add Mermaid flowchart showing pipeline stages and GitHub API integration - Document new github_api, glrd, and sphinx_builder modules - Add GitHub token setup instructions for make aggregate - Improve CI workflow reference table formatting - Add troubleshooting section for API rate limits Signed-off-by: Eike Waldt <waldt@b1-systems.de> On-behalf-of: SAP <eike.waldt@sap.com> Assisted-by: Kilo:claude-opus-4-7 Assisted-by: Kilo:claude-sonnet-4-6
✅ Deploy Preview for gardenlinux-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
ByteOtter
approved these changes
Jul 9, 2026
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
2 participants
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.
What this PR does / why we need it:
GLRD can list a release before its GitHub Release tag is created (a release in process). This caused the release table and release-note pages to include entries with broken or missing content.
aggregation/github_apimodule — centralized GitHub HTTP client (get_json,list_repo_releases) withGITHUB_TOKENauth support and actionable rate-limit error messages.aggregate.py— all GitHub releases are fetched once upfront and passed to both release generators, replacing the ad-hoccurl-based approach inrelease_notes.py.generate_release_tablenow acceptsexisting_gh_tagsand silently skips any minor GLRD release that has no matching GitHub tag; a warning is written to stderr for each skipped row.GITHUB_TOKENsetup instructions + a rate-limit troubleshooting entry to the working-locally guide.