Skip to content

feat: added github action to label long pending issues as 'stale' #239

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

cmeesters
Copy link
Member

@cmeesters cmeesters commented Mar 14, 2025

added the same GitHub action as in the main repository. Should label old issues as "stale".

Summary by CodeRabbit

  • Chores
    • Introduced an automation that regularly identifies inactive issues and pull requests. The system marks items as inactive after a set period and, if unaddressed, closes issues while flagging pull requests. Custom notifications are provided to keep users informed on the status of their contributions.

Copy link
Contributor

coderabbitai bot commented Mar 14, 2025

Walkthrough

A new GitHub Actions workflow file (.github/workflows/stale.yml) has been added to automate the management of inactive issues and pull requests. This workflow runs weekly on Monday at 1:01 AM UTC on an Ubuntu runner. It uses the actions/stale@v5 action to mark issues and pull requests as stale after 180 days of inactivity, closing issues if they remain inactive for an additional 365 days, while pull requests are only marked stale. The workflow uses a repository token from GitHub secrets for authentication.

Changes

File(s) Change Summary
.github/workflows/stale.yml Introduces a new workflow that marks issues as stale after 180 days of inactivity and closes them after 365 more days, while marking stale PRs.

Sequence Diagram(s)

sequenceDiagram
    participant Scheduler as GitHub Scheduler
    participant Runner as Ubuntu Runner
    participant StaleAction as actions/stale@v5
    participant Repo as Repository

    Scheduler->>Runner: Trigger workflow (Mon, 1:01 AM UTC)
    Runner->>StaleAction: Execute close-issues job
    StaleAction->>Repo: Mark issues stale (after 180 days inactivity)
    StaleAction->>Repo: Close issues (after additional 365 days inactivity)
    StaleAction->>Repo: Mark pull requests stale (after 180 days inactivity)
Loading

Poem

I'm a bunny with a joyful hop,
Automating tasks nonstop!
Issues grow stale like carrots left behind,
Closed or tagged, in order they're aligned.
Hopping through repos, keeping code sublime —
Hip-hip-hooray for changes, every time! 🐰✨

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5e591ae and 09a5016.

📒 Files selected for processing (1)
  • .github/workflows/stale.yml (1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/stale.yml

13-13: the runner of "actions/stale@v5" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: testing
🔇 Additional comments (4)
.github/workflows/stale.yml (4)

1-5: Schedule Configuration is Clear and Correct
The cron expression ("1 1 * * 1") is correctly set to run weekly on Monday at 1:01 AM UTC, meeting the intended schedule for identifying stale issues.


6-12: Job Definition and Permissions are Configured Properly
The "close-issues" job is set to run on the latest Ubuntu runner and assigns the necessary write permissions for both issues and pull requests. This setup is straightforward and aligns with best practices for workflow jobs.


14-23: Stale Action Configuration Parameters Appear Sound
The configuration parameters (e.g., days-before-issue-stale, days-before-issue-close, and the custom messages) are well-defined and clearly communicate the intended behavior for marking and closing stale issues and marking pull requests. Please ensure these thresholds align with your repository’s policies for issue management.


13-13:

✅ Verification successful

Action Version Update Recommended
Static analysis indicates that using actions/stale@v5 might be too old for current GitHub Actions runners. It is recommended to update the action version to a more recent release (for example, actions/stale@v6) if available, to ensure better performance and compatibility.

-      - uses: actions/stale@v5
+      - uses: actions/stale@v6

Action Version Update Implementation

After reviewing the workflow, it’s confirmed that the workflow currently uses actions/stale@v5, which appears to be outdated for current GitHub Actions runners. Updating to a more recent release (e.g., actions/stale@v6) should improve performance and compatibility.

  • Location: .github/workflows/stale.yml, line 13
  • Update Suggestion:
-      - uses: actions/stale@v5
+      - uses: actions/stale@v6
🧰 Tools
🪛 actionlint (1.7.4)

13-13: the runner of "actions/stale@v5" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @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.

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.

@cmeesters cmeesters requested a review from dlaehnemann March 27, 2025 18:20
@cmeesters
Copy link
Member Author

@johanneskoester should be similar to the main repo, right?

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.

1 participant