Skip to content
generated from ajndkr/uv-boilerplate

generate weekly reports of all code changes in a github repository

License

Notifications You must be signed in to change notification settings

ajndkr/pr-pulse

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

pr-pulse

Analyze merged pull requests and generate insights.

usage

basic example

name: pr-pulse-insights
on:
  schedule:
    - cron: "0 8 * * 1" # Runs at 8:00 AM UTC every Monday

jobs:
  run:
    runs-on: ubuntu-latest
    steps:
      - name: generate insights summary
        uses: ajndkr/pr-pulse@v0
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          repository: "owner/repo"
          days: "7"

input parameters

Parameter Description Required Default
github_token GitHub token for repository access Yes -
api_key GEMINI API key for report command No -
repository Target repository in format owner/repo Yes -
days Number of days to look back for PRs No 7
share Share insights on Slack No false
slack_webhook_url Slack webhook URL to share insights No -

Note: To create a Slack webhook URL, refer to Slack Incoming Webhooks.

local development

pre-requisites

init project

make init

to run pre-commit checks, run:

make ci

run commands

run the following to view the list of available commands:

make run

project roadmap

phase 1

  • setup project
  • create commands to fetch data from github
  • convert project to github action to schedule cron jobs in target repository
  • add llm integration to generate weekly report
  • add slack integration to send weekly report

phase 2

  • improve customisability of commands
  • add MCP support
  • add support for more LLM providers