Skip to content

Feature: Build a NEWS Bot for Lecture Repositories #285

@mmcky

Description

@mmcky

Summary

Build a NEWS bot (GitHub Action) that monitors QuantEcon lecture repositories for recent changes and automatically opens a PR with a suggested news summary for the website or newsletter.

Motivation

Keeping the QuantEcon community informed about updates to our lecture content is important but manual. A bot that automatically detects significant changes and drafts news summaries would:

  • Reduce manual effort in tracking changes across multiple repositories
  • Ensure timely communication of updates to our audience
  • Provide consistent formatting for news items
  • Make it easier to maintain an active news/changelog presence

Proposed Functionality

Core Features

  1. Monitor Lecture Repositories - Scan configured lecture repositories for recent commits/PRs merged
  2. Detect Significant Changes - Filter for meaningful updates (new lectures, major revisions, bug fixes)
  3. Generate News Summary - Use AI to draft a human-readable summary of changes
  4. Open PR with Summary - Automatically create a PR with the suggested news content

Configuration Options

  • List of repositories to monitor
  • Frequency of checks (weekly, bi-weekly)
  • Types of changes to include (new content, updates, fixes)
  • Output format (markdown, newsletter format)
  • Target repository for news PRs

Example Workflow

name: Generate News Summary
on:
  schedule:
    - cron: '0 9 * * 1'  # Weekly on Monday
  workflow_dispatch:

jobs:
  news-bot:
    runs-on: ubuntu-latest
    steps:
      - uses: QuantEcon/action-news-bot@main
        with:
          repositories: |
            QuantEcon/lecture-python-intro
            QuantEcon/lecture-python.myst
            QuantEcon/lecture-jax
          lookback-days: 7
          ai-summary: true
          target-repo: QuantEcon/website
          target-branch: news-updates

Implementation Considerations

  • Should integrate with existing QuantEcon action patterns
  • Could leverage the same AI infrastructure as action-link-checker
  • News summaries should be editable before final publication
  • Consider rate limiting and API usage for AI summarization

Related

Tasks

  • Design news summary format/template
  • Implement repository change detection
  • Integrate AI summarization
  • Build PR creation workflow
  • Add configuration options
  • Documentation and examples

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions