Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create monthly-issue-metircs.yml #862

Merged
merged 2 commits into from
Aug 27, 2024
Merged

Create monthly-issue-metircs.yml #862

merged 2 commits into from
Aug 27, 2024

Conversation

sbvegan
Copy link
Collaborator

@sbvegan sbvegan commented Aug 27, 2024

Description

Adding a github action workflow that will generate a report around the metrics for the issues in that month.

@sbvegan sbvegan requested a review from a team as a code owner August 27, 2024 02:22
Copy link
Contributor

coderabbitai bot commented Aug 27, 2024

Walkthrough

Two new GitHub Actions workflows, monthly-issue-metrics.yml and monthly-pr-metrics.yml, have been added to automate the generation of monthly reports for issues and pull requests, respectively. Both workflows can be triggered manually or scheduled to run on the first day of each month. They calculate the previous month's date range, gather relevant metrics, and create summary issues based on the collected data.

Changes

File Path Change Summary
.github/workflows/monthly-issue-metrics.yml, .github/workflows/monthly-pr-metrics.yml Added new GitHub Actions workflows to automate monthly issue and PR metrics reporting, including issue creation and date range calculation.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub Actions
    participant Issue Metrics Action
    participant Issue Creation Action

    User->>GitHub Actions: Trigger issue metrics workflow
    GitHub Actions->>GitHub Actions: Calculate previous month's date range
    GitHub Actions->>Issue Metrics Action: Gather metrics for opened issues
    Issue Metrics Action-->>GitHub Actions: Return opened issues metrics
    GitHub Actions->>Issue Creation Action: Create issue for opened issues
    GitHub Actions->>Issue Metrics Action: Gather metrics for closed issues
    Issue Metrics Action-->>GitHub Actions: Return closed issues metrics
    GitHub Actions->>Issue Creation Action: Create issue for closed issues

    User->>GitHub Actions: Trigger PR metrics workflow
    GitHub Actions->>GitHub Actions: Calculate previous month's date range
    GitHub Actions->>Issue Metrics Action: Gather metrics for opened PRs
    Issue Metrics Action-->>GitHub Actions: Return opened PRs metrics
    GitHub Actions->>Issue Creation Action: Create issue for opened PRs
    GitHub Actions->>Issue Metrics Action: Gather metrics for closed PRs
    Issue Metrics Action-->>GitHub Actions: Return closed PRs metrics
    GitHub Actions->>Issue Creation Action: Create issue for closed PRs
Loading

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b98c3ab and 19f6661.

Files selected for processing (2)
  • .github/workflows/monthly-issue-metircs.yml (1 hunks)
  • .github/workflows/monthly-pr-metrics.yml (1 hunks)
Files skipped from review due to trivial changes (1)
  • .github/workflows/monthly-issue-metircs.yml
Additional comments not posted (4)
.github/workflows/monthly-pr-metrics.yml (4)

1-10: LGTM!

The workflow setup and permissions are appropriate for generating the monthly PR metrics report.

The code changes are approved.


11-30: LGTM!

The job setup and date calculation logic are correct. The use of bash for date calculations is appropriate.

The code changes are approved.


31-46: LGTM!

The step correctly uses the issue-metrics tool and creates an issue with the report for opened PRs. The use of environment variables and secrets is appropriate.

The code changes are approved.


47-60: LGTM!

The step correctly uses the issue-metrics tool and creates an issue with the report for closed PRs. The use of environment variables and secrets is appropriate.

The code changes are approved.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

netlify bot commented Aug 27, 2024

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit 19f6661
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/66cd38f690e7130008c35032
😎 Deploy Preview https://deploy-preview-862--docs-optimism.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@sbvegan sbvegan merged commit 044dc37 into main Aug 27, 2024
7 of 8 checks passed
@sbvegan sbvegan deleted the sbvegan-patch-1 branch August 27, 2024 14:32
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.

2 participants