Daily Summary

Generate daily GitHub summaries of newly created pull requests (PRs) and commits, categorized by organization. Optionally, use Ollama to generate a brief summary of each PR based on its title. Additionally, you can leverage the daily GitHub workflow to automate the tool’s execution, submitting the report as a GitHub issue.

Requirements

1. Ollama installed
2. Ollama mistral model (optional)
3. Python + UV

Creating a Github token

daily-summary needs a Github token to fetch organization/user PRs and commits. To create one, follow these steps:

1. Create a Github token with the following permissions:
   1. repo -> Check all
   2. admin:org -> Check read:org
   3. user -> Check all
2. Authorize the token if your organization has SAML enabled. Follow this guide for instructions

Installing

To install run:

uv sync

To check if its properly installed:

uv run task cli --help

Usage

Ensure your GitHub token is available in your environment as GITHUB_TOKEN, or provide the token as a parameter to the command using:

uv run task cli --token <GITHUB_TOKEN> ...

Generate daily summaries based on PRs and commits

This will default to today's date.

uv run task cli daily-summary

Generate daily summaries based on PRs and commits from yesterday

uv run task cli daily-summary --yesterday

Generate daily summaries based on PRs and commits for a specific date

uv run task cli daily-summary --date 2025-02-28

Generate daily summaries based on PRs and commits for a particular username

uv run task cli --username github-bot daily-summary

List today's PR

uv run task cli list-issues

List PRs from a specific date

uv run task cli list-issues --date 2025-02-28

List commits from a specific date

uv run task cli list-commits --date 2025-02-28

Showing account details

uv run task cli account

Other usages

For more usages, use:

uv run task cli --help

Using the Github workflow

1. Fork the repository
2. Follow the steps shown in section Creating a Github token
3. Add the newly created token to your CI secrets as GH_TOKEN. See this guide for more details
4. Update the GitHub workflow configuration:
   • Replace the values of SUMMARY_REPOSITORY and SUMMARY_ASSIGNEE in the environment variables with your summary repository and assignee.

Screenshot