Skip to content

Conversation

@hwakabh
Copy link
Owner

@hwakabh hwakabh commented Feb 11, 2025

Issue/PR link

relates: #524

What does this PR do?

Describe what changes you make in your branch:

  • fixed typo in workflow file (permission -> permissions)
  • merged stale-issue action into cleanups workflow

(Optional) Additional Contexts

Describe additional information for reviewers (i.e. What does not included)

  • e2e testings are not included in this PR, since this requires merge into main to confirm changes would be applied

Summary by CodeRabbit

  • New Features

    • Introduced a new job for managing stale issues, including notifications and automatic closure.
    • Adjusted the timing of scheduled workflows for better alignment.
  • Chores

    • Updated permission settings for issue management to enhance functionality.
    • Removed redundant workflow to streamline automation processes.

@coderabbitai
Copy link

coderabbitai bot commented Feb 11, 2025

Walkthrough

The pull request updates the GitHub Actions workflow in .github/workflows/cleanup.yaml by changing its schedule to run at 23:30 JST (14:30 UTC), modifying the permissions declaration (renaming from permission to permissions and adding issues: write), and adding a new job close-issues that uses the actions/stale action to handle stale issues. Additionally, the standalone stale issues workflow in .github/workflows/stele-issues.yaml has been removed.

Changes

File Change Summary
.github/workflows/cleanup.yaml Updated schedule from 19:00 JST (10:00 UTC) to 23:30 JST (14:30 UTC); renamed the permission key to permissions and added issues: write; added new job close-issues to utilize actions/stale for managing stale issues.
.github/workflows/stele-issues.yaml Removed the workflow that previously managed stale issues utilizing actions/stale.

Possibly related PRs

  • feat(ci): added cleanup workflows for deployment/images. #524: The changes in the main PR regarding the management of stale issues in the cleanup.yaml workflow are directly related to the previously existing stele-issues.yaml workflow, which also handled stale issues, indicating a transition from one workflow to another.
  • fix(ci): workflow id depended on deploy jobs. #499: The changes in the main PR regarding the management of stale issues in the cleanup.yaml workflow are directly related to the functionality of the close-issues job, which is also present in the deleted stele-issues.yaml workflow, indicating a focus on similar issue management tasks.
  • feat: enabled CodeQL #492: The changes in the main PR regarding the management of stale issues in the cleanup.yaml workflow are directly related to the functionality introduced in the deleted stele-issues.yaml workflow, which also managed stale issues.

Suggested labels

chore


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c580bf1 and 317740b.

📒 Files selected for processing (1)
  • .github/workflows/cleanup.yaml (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/cleanup.yaml
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: CodeQL (javascript-typescript)

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@github-actions github-actions bot added bugs Something isn't working ci Topics on workflows or automations deploy Features depending on application runtimes labels Feb 11, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 659dc95 and c580bf1.

📒 Files selected for processing (2)
  • .github/workflows/cleanup.yaml (2 hunks)
  • .github/workflows/stele-issues.yaml (0 hunks)
💤 Files with no reviewable changes (1)
  • .github/workflows/stele-issues.yaml
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/cleanup.yaml

10-10: "delete" is invalid for permission of scope "packages". available values are "read", "write" or "none"

(permissions)


11-11: "delete" is invalid for permission of scope "deployments". available values are "read", "write" or "none"

(permissions)

🔇 Additional comments (2)
.github/workflows/cleanup.yaml (2)

5-6: LGTM! Well-documented schedule change.

The cron schedule is correctly set to 14:30 UTC (23:30 JST) and includes a helpful comment explaining the timezone conversion.


38-52: LGTM! Well-configured stale issues management.

The stale issues job is well-configured with:

  • Clear messages for stale and closed states
  • Reasonable timeframes (14 days before stale, 3 days before close)
  • PRs explicitly excluded from staling
  • Latest version of actions/stale@v9

@hwakabh hwakabh merged commit 1d8eaaa into main Feb 11, 2025
7 checks passed
@hwakabh hwakabh deleted the fix/cleanup branch February 11, 2025 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugs Something isn't working ci Topics on workflows or automations deploy Features depending on application runtimes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants