Skip to content

Stabilize scheduled GitHub Actions, enable weekly automated content curation, and improve documentation quality#9

Merged
moshesham merged 4 commits intomainfrom
copilot/fix-current-action-problems
Apr 27, 2026
Merged

Stabilize scheduled GitHub Actions, enable weekly automated content curation, and improve documentation quality#9
moshesham merged 4 commits intomainfrom
copilot/fix-current-action-problems

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 27, 2026

This PR addresses recurring failures in scheduled workflows, advances the weekly content-agent path by making automated discovery/updates robust under current repository permissions and runtime behavior, and improves the quality, accuracy, and structure of repository content.

  • Workflow breakage fixes (current failures)

    • Added required leaderboard anchors in README.md so scripts/generate_leaderboard.py can update content in-place.
    • Made quiz leaderboard automation resilient when ISSUE_NUMBER is absent (common on schedule / workflow_dispatch) by resolving the target issue via quiz-leaderboard label.
    • Fixed stale-content automation datetime comparisons by normalizing to timezone-aware UTC datetimes.
  • Awesome List agent flow hardening

    • Replaced PR-creation step in awesome-list-aggregator.yml with direct commit/push for discovered content updates, avoiding failure mode where Actions cannot open PRs in this repo configuration.
    • Updated trusted source config and defaults to valid Iceberg blog/feed endpoints to prevent repeated fetch failures.
  • Content quality and structure improvements

    • README.md: Replaced vague badge labels with version-specific ones (Delta Lake 3.x, Iceberg 1.5+); added a sharp one-liner description; replaced the verbose Vision Statement with a focused needs→content table; added a full repository tree with inline descriptions; converted the automation bullet list into a structured table with trigger and schedule for each of the 7 workflows; merged duplicated "Getting Started" sections; fixed broken quiz/ internal links → quiz.md.
    • docs/awesome-list.md: Replaced 2024-01-01 placeholder articles with four current real resources (Delta Lake 3.2 Liquid Clustering, Iceberg 1.5, 2025 format comparison, AWS lakehouse guide); updated books section with full publication details including the O'Reilly Iceberg Definitive Guide (2024); added Dremio benchmark reference; updated Last Updated date.
    • docs/comparisons/feature-matrix.md: Replaced [CURRENT_DATE] placeholder with 2026-04-27 and added explicit Delta 3.2 / Iceberg 1.5 version coverage note.
    • docs/tutorials/migration-guide.md: Removed leaked Windows file-path artifact (</content><parameter name="filePath">c:\Users\...) from end of file.
    • docs/architecture/system-overview.md: Updated the Resource Aggregation Flow sequence diagram to reflect the current push-based commit approach instead of the now-removed PR-creation step.
    • QUICKSTART.md: Added update-quiz-leaderboard.yml to the workflow listing; expanded Resource Aggregation and Quiz Leaderboard automation descriptions to match current behavior.

@moshesham
Copy link
Copy Markdown
Contributor

@copilot Review the content and the structure and beef up and improve the quality of the content

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 27, 2026

@copilot Review the content and the structure and beef up and improve the quality of the content

Done in commit 5a7f95c. Here's a summary of what was improved:

README.md

  • Replaced vague badge labels with version-specific ones (Delta Lake 3.x, Iceberg 1.5+)
  • Added a sharp one-line description at the top
  • Replaced the verbose "Vision Statement" with a focused needs→content table
  • Added a full repository tree with inline descriptions
  • Converted the "Living Whitepaper" bullet list into an automation table with trigger, description, and schedule for each of the 7 workflows
  • Converted the Tech Stack into a properly formatted table
  • Merged the duplicated "How to Use" / "Getting Started" sections into a single structured learner path table with role-specific guidance for learners, contributors, and architects
  • Fixed broken quiz/ internal links → quiz.md

docs/awesome-list.md

  • Replaced 2024-01-01 placeholder articles with four current, real resources (Delta Lake 3.2 Liquid Clustering, Iceberg 1.5, 2025 comparison post, AWS lakehouse guide)
  • Updated book entries with full publication details and the O'Reilly Iceberg Definitive Guide (2024)
  • Added a fourth benchmarking reference (Dremio 2024 comparison)
  • Updated Last Updated to current date

docs/comparisons/feature-matrix.md

  • Replaced [CURRENT_DATE] placeholder with 2026-04-27 and added version coverage note (Delta 3.2, Iceberg 1.5)

docs/tutorials/migration-guide.md

  • Removed leaked Windows file-path artifact at the end of the file (</content><parameter name="filePath">c:\Users\Moshe\...)

docs/architecture/system-overview.md

  • Updated Resource Aggregation Flow sequence diagram to reflect the current push-based commit approach instead of the defunct PR-creation step

QUICKSTART.md

  • Added update-quiz-leaderboard.yml to the workflow listing with descriptions
  • Expanded the Resource Aggregation and Quiz Leaderboard automation descriptions to match actual current behavior

Copilot AI changed the title Stabilize scheduled GitHub Actions and enable weekly automated content curation updates Stabilize scheduled GitHub Actions, enable weekly automated content curation, and improve documentation quality Apr 27, 2026
Copilot AI requested a review from moshesham April 27, 2026 19:36
@moshesham moshesham marked this pull request as ready for review April 27, 2026 19:48
Copilot AI review requested due to automatic review settings April 27, 2026 19:48
@moshesham moshesham merged commit 7a5c078 into main Apr 27, 2026
7 checks passed
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR stabilizes several scheduled GitHub Actions (leaderboard, quiz leaderboard, stale-content bot, and resource aggregation), hardens the weekly content aggregation path to work under current repo permissions, and refreshes/cleans up key documentation pages.

Changes:

  • Made scheduled automations more resilient (quiz leaderboard issue resolution; stale-docs timezone handling; fixed trusted-source endpoints).
  • Switched the awesome-list aggregator from PR creation to direct commit/push updates.
  • Refreshed and corrected documentation content/structure (README, awesome list resources, feature matrix metadata, migration guide cleanup, architecture diagram updates).

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 8 comments.

Show a summary per file
File Description
scripts/update_quiz_leaderboard.py Adds fallback issue resolution via quiz-leaderboard label when ISSUE_NUMBER is absent.
scripts/find_stale_docs.py Normalizes datetimes to UTC for correct comparisons; adjusts directories scanned.
scripts/find_new_articles.py Fixes Iceberg blog URL to a valid endpoint.
scripts/config/trusted_sources.json Updates trusted sources to valid Iceberg RSS/blog endpoints.
docs/tutorials/migration-guide.md Removes leaked Windows file-path/XML artifact from the end of the doc.
docs/comparisons/feature-matrix.md Replaces placeholder last-reviewed date; adds explicit version coverage note.
docs/awesome-list.md Replaces placeholder resources with current real links; updates books/benchmarks and last-updated date.
docs/architecture/system-overview.md Updates the aggregation sequence diagram to reflect the new push-based update flow.
README.md Major doc restructure + adds required leaderboard anchors for automation; updates links and workflow descriptions.
QUICKSTART.md Updates workflow listing and expands automation descriptions (resource aggregation + quiz leaderboard).
.github/workflows/awesome-list-aggregator.yml Replaces PR creation with direct git commit/push of aggregated content updates.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines 17 to 19
STALE_THRESHOLD_MONTHS = 12
DIRECTORIES_TO_CHECK = ["docs/", "tutorials/"]
DIRECTORIES_TO_CHECK = ["docs/", "docs/tutorials/"]
STALE_LABEL = "stale-content"
Comment on lines +85 to +89
for issue in repo.get_issues(state="open"):
if any(label.name == QUIZ_LABEL for label in issue.labels):
return issue.number

return None
if git diff --cached --quiet; then
echo "ℹ️ No file changes to commit"
else
git commit -m "Add new curated resources to awesome list [skip ci]"
AI-->>Agg: Summaries (or simple fallback)
Agg->>Repo: Update docs/awesome-list.md
Agg->>Repo: Update community/processed_urls.json
Repo->>Repo: git commit & push [skip ci]
Comment thread README.md
Comment on lines +80 to +88
| Automation | Trigger | What It Does |
|-----------|---------|-------------|
| **Code Recipe CI** | Every PR | Lints Python, runs `validate.sh` per recipe |
| **Documentation CI** | Every PR | Markdownlint, link checker, Mermaid diagram validation |
| **Stale Content Bot** | Weekly (Mon) | Opens issues for docs untouched > 12 months |
| **Resource Aggregator** | Weekly (Sun) | Discovers new articles from RSS feeds, commits to awesome list |
| **Leaderboard Update** | Daily | Regenerates top-10 contributor table in README |
| **Gamification Engine** | PR/Review/Issue | Awards points and updates contributor stats |
| **Quiz Leaderboard** | Issue comment | Updates quiz scores in the leaderboard issue |
Comment thread README.md
- [🏗️ **Production Readiness**](docs/best-practices/production-readiness.md) — Best practices for production
- [🤝 **Contributing Guide**](CONTRIBUTING.md) — Earn points, join the community
- [📜 **Code of Conduct**](CODE_OF_CONDUCT.md) — Community standards
- [🏆 **Community Leaderboard**](#-community-leaderboard) — Top contributors
Comment thread QUICKSTART.md
│ ├── gamification-engine.yml # Points on PR/review/issue events
│ ├── update-leaderboard.yml # Daily: regenerate README leaderboard
│ ├── update-quiz-leaderboard.yml # Update quiz scores in leaderboard issue
│ └── awesome-list-aggregator.yml # Weekly: discover & commit new articles
Comment on lines 159 to 163
issue_body = f"""## 📅 Stale Content Detected

**File:** `{filepath}`
**Last Updated:** {last_modified.strftime('%Y-%m-%d')} ({(datetime.now() - last_modified).days} days ago)
**Last Updated:** {last_modified.strftime('%Y-%m-%d')} ({age_days} days ago)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants