Skip to content

Fix .github/workflows/pr-description.yml to support current PR structure - #1506

Merged
scottanderson merged 2 commits into
openfrontio:mainfrom
Aotumuri:fix-pr-desc-yml
Jul 20, 2025
Merged

scottanderson merged 2 commits into
openfrontio:mainfrom
Aotumuri:fix-pr-desc-yml

Conversation

@Aotumuri

Copy link
Copy Markdown
Member

Description:

This PR fixes an issue in .github/workflows/pr-description.yml where the logic for detecting checkboxes did not match the current PR format.
The condition was incorrect, so it has been updated to correctly validate the checkbox state.

Please complete the following:

  • I have added screenshots for all UI updates
  • I process any text displayed to the user through translateText() and I've added it to the en.json file
  • I have added relevant tests to the test directory
  • I confirm I have thoroughly tested these changes and take full responsibility for any bugs introduced
  • I have read and accepted the CLA aggreement (only required once).

Please put your Discord username so you can be contacted if a bug or regression is found:

aotumuri

@coderabbitai

coderabbitai Bot commented Jul 20, 2025 •

Copy link
Copy Markdown
Contributor

Walkthrough

The GitHub Actions workflow for pull request description validation was updated. The checklist now requires contributors to confirm they have read and accepted the Contributor License Agreement (CLA), replacing the previous item about understanding the impact of buggy code. The regex pattern was adjusted to match this new checklist item.

Changes

File(s) Change Summary
.github/workflows/pr-description.yml Updated checklist validation: replaced last item with CLA agreement confirmation and updated regex pattern accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant Contributor
    participant GitHub Actions

    Contributor->>GitHub Actions: Open Pull Request with Description
    GitHub Actions->>GitHub Actions: Validate Description Section
    GitHub Actions->>GitHub Actions: Check Checklist Items (including new CLA agreement)
    GitHub Actions-->>Contributor: Pass/Fail Status on PR
Loading

Possibly related PRs

Suggested labels

GitHub Actions

Suggested reviewers

  • evanpelle

Poem

In the land of pull requests, a checklist did grow,
But now it asks, before you go,
"Have you read the CLA? Please say yes!"
Regex patterns dance, ensuring no mess.
Code and agreements, hand in hand,
The workflow’s updated, just as planned!
✍️🤖


📜 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 123787e and 820422e.

📒 Files selected for processing (1)
  • .github/workflows/pr-description.yml (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: andrewNiziolek
PR: openfrontio/OpenFrontIO#1007
File: resources/lang/de.json:115-115
Timestamp: 2025-06-02T14:27:37.609Z
Learning: For OpenFrontIO project: When localization keys are renamed in language JSON files, the maintainers separate technical changes from translation content updates. They wait for community translators to update the actual translation values rather than attempting to translate in the same PR. This allows technical changes to proceed while ensuring accurate translations from native speakers.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: 🏗️ Build

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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 sequence diagram to generate a sequence diagram of the changes in 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.

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-project-automation github-project-automation Bot moved this from Triage to Final Review in OpenFront Release Management Jul 20, 2025
@scottanderson scottanderson added this to the v24 milestone Jul 20, 2025
@scottanderson
scottanderson enabled auto-merge (squash) July 20, 2025 07:12
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ Aotumuri
❌ scottanderson
You have signed the CLA already but the status is still pending? Let us recheck it.

@scottanderson
scottanderson merged commit d47f550 into openfrontio:main Jul 20, 2025
@github-project-automation github-project-automation Bot moved this from Final Review to Complete in OpenFront Release Management Jul 20, 2025
@coderabbitai coderabbitai Bot mentioned this pull request Aug 12, 2025
4 tasks done
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: Complete

Development

Successfully merging this pull request may close these issues.

3 participants