Skip to content

integrate HACS validation workflow#322

Merged
dirixmjm merged 4 commits intomainfrom
hacs
Aug 29, 2025
Merged

integrate HACS validation workflow#322
dirixmjm merged 4 commits intomainfrom
hacs

Conversation

@dirixmjm
Copy link
Copy Markdown
Contributor

@dirixmjm dirixmjm commented Aug 29, 2025

Summary by CodeRabbit

  • Chores

    • Added automated CI validation that runs on push, pull request, daily schedule, and manual trigger to continuously check integration health.
    • Runs integration validation steps to catch issues early and improve release reliability.
  • Chores

    • Added an issue tracker URL to the Plugwise USB integration manifest so users can file bugs/requests.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Aug 29, 2025

Warning

Rate limit exceeded

@dirixmjm has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 53 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between e171007 and 1b11f77.

📒 Files selected for processing (3)
  • .github/workflows/validate.yaml (1 hunks)
  • custom_components/plugwise_usb/manifest.json (1 hunks)
  • pyproject.toml (1 hunks)

Walkthrough

Adds a GitHub Actions workflow (.github/workflows/validate.yaml) that runs HACS validation on push, pull_request, daily schedule, and manual dispatch; and adds an issue_tracker field to custom_components/plugwise_usb/manifest.json pointing to the repository issues URL.

Changes

Cohort / File(s) Change summary
CI Workflow
.github/workflows/validate.yaml
Added "Validate" workflow triggered by push, pull_request, schedule (cron: "0 0 * * *"), and workflow_dispatch. Defines job validate-hacs on ubuntu-latest with a step "HACS validation" using hacs/action@22.5.0 and input category: "integration". Sets permissions: {}.
Manifest metadata
custom_components/plugwise_usb/manifest.json
Added issue_tracker property with value https://github.com/plugwise/plugwise_usb-beta/issues. No other manifest fields changed.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant Dev as Developer
  participant GH as GitHub
  participant WF as Workflow: Validate
  participant ACT as Action: hacs/action@22.5.0
  Note over GH,WF: Triggers: push, pull_request, schedule (daily), workflow_dispatch
  Dev->>GH: Push / open PR / schedule / manual dispatch
  GH-->>WF: Start Validate workflow
  WF->>ACT: Run HACS validation (category: integration)
  ACT-->>WF: Return result (success/failure)
  WF-->>GH: Report job status
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I hop through YAML lines at dawn,
A nightly cron keeps me on.
I tuck an issues link in place,
And let HACS run its tidy race.
Carrots for green checks—what a chase! 🥕

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch hacs

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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore or @coderabbit 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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

@dirixmjm dirixmjm marked this pull request as ready for review August 29, 2025 17:37
@dirixmjm dirixmjm requested a review from a team as a code owner August 29, 2025 17:37
Copy link
Copy Markdown
Contributor

@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

🧹 Nitpick comments (3)
.github/workflows/validate.yaml (3)

15-19: Consider adding a checkout step (optional) to validate the actual workspace.

HACS examples sometimes include actions/checkout before running the action. While the HACS action can read public repos without checkout, checking out ensures local changes in PRs are what gets validated and avoids surprises. If you add checkout, also grant minimal permissions.

Suggested change:

     steps:
+      - name: Checkout
+        uses: actions/checkout@v4
       - name: HACS validation
-        uses: "hacs/action@22.5.0"
+        uses: "hacs/action@22.5.0"
         with:
           category: "integration"

Docs reference both patterns (with and without checkout). Please verify the action behaves as expected for forked PRs in this repo. (hacs.dev, hacs.xyz)


10-10: Permissions: confirm minimal rights match your step choices.

permissions: {} is fine if you skip checkout (public repo). If you add actions/checkout, set contents: read to avoid token failures.

Example:

-permissions: {}
+permissions:
+  contents: read

Reference HACS docs showing permissions: {} when not using checkout. (hacs.xyz)


3-9: Add concurrency to avoid overlapping runs (optional).

Prevents duplicate validations on rapid pushes to the same ref.

 on:
   push:
   pull_request:
   schedule:
     - cron: "0 0 * * *"
   workflow_dispatch:
+
+concurrency:
+  group: validate-hacs-${{ github.ref }}
+  cancel-in-progress: true
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 2345ad9 and d78c2e2.

📒 Files selected for processing (1)
  • .github/workflows/validate.yaml (1 hunks)
🔇 Additional comments (1)
.github/workflows/validate.yaml (1)

3-9: Triggers and schedule look good.
Runs on PRs, pushes, daily cron, and manual dispatch as per HACS guidance.

(hacs.xyz)

Copy link
Copy Markdown
Member

@CoMPaTech CoMPaTech left a comment

Choose a reason for hiding this comment

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

Good call!

@sonarqubecloud
Copy link
Copy Markdown

@dirixmjm dirixmjm merged commit d9c813a into main Aug 29, 2025
12 checks passed
@dirixmjm dirixmjm deleted the hacs branch August 30, 2025 12:51
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