Activity Analyzer - Initial Release Notes

Activity Analyzer - Initial Release Notes

Overview

The Activity Analyzer tool is designed to help GitHub users track and analyze the activity in their repositories by evaluating merged pull requests. It automatically generates detailed reports comparing current period activities with previous periods, providing valuable insights into project trends and individual contributions.

Key Features

1. Pull Request Analysis

   • Tracks and aggregates the number of merged pull requests over a specified period.
   • Generates detailed breakdowns of pull request activity by individual contributors, comparing the current and previous periods.

2. Comprehensive Report Generation

   • Generates customizable reports using Mustache templates. The reports are rendered in the desired language based on configuration settings.
     • Supports English and Japanese report templates.
   • The tool automatically posts the generated report as a GitHub Issue.

3. Flexible Configuration

   • Custom configuration options for the report’s language (lang), title (title), and period (period) are available via the .github/config.yaml file.
   • Supports configuration for either the last one week or two weeks, allowing side-by-side comparisons between periods.

Execution Flow

1. Trigger: The action is triggered when a pull request is submitted to the main branch.
2. Checkout: The repository is checked out using actions/checkout@v3.
3. Input Processing: The action reads the input parameters, including repository details, GitHub token, and the configuration file path.
4. Data Fetching: The action fetches pull request data from the GitHub API and aggregates the necessary details.
5. Report Rendering: The data is processed and formatted using Mustache templates to generate the final report.
6. Issue Creation: The report is automatically posted as a GitHub Issue in the repository.