Skip to content

Migrate actions to plugwise common gh-actions #760

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

Merged
merged 1 commit into from
Jun 23, 2025
Merged

Migrate actions to plugwise common gh-actions #760

merged 1 commit into from
Jun 23, 2025

Conversation

CoMPaTech
Copy link
Member

@CoMPaTech CoMPaTech commented Jun 21, 2025

Summary by CodeRabbit

  • Chores
    • Removed the custom GitHub Action for restoring and setting up Python virtual environments and pre-commit dependencies.
    • Updated workflow configuration to use standardized external actions for Python environment setup and caching, streamlining and unifying the process across jobs.

@CoMPaTech CoMPaTech self-assigned this Jun 21, 2025
@CoMPaTech CoMPaTech requested a review from a team as a code owner June 21, 2025 19:28
@CoMPaTech CoMPaTech added enhancement New feature or request dependencies Pull requests that update a dependency file quality labels Jun 21, 2025
Copy link
Contributor

coderabbitai bot commented Jun 21, 2025

Walkthrough

This change removes the custom composite GitHub Action for restoring and preparing Python virtual environments, and updates the workflow to use external reusable actions for Python setup and caching. The workflow is streamlined by delegating environment preparation and cache restoration to actions from the plugwise/gh-actions repository.

Changes

File(s) Change Summary
.github/actions/restore-venv/action.yml Deleted the custom composite action for restoring venv and pre-commit from cache.
.github/workflows/verify.yml Replaced local Python setup and caching steps with reusable actions from plugwise/gh-actions.

Sequence Diagram(s)

sequenceDiagram
    participant GitHub Actions
    participant plugwise/gh-actions

    GitHub Actions->>plugwise/gh-actions: prepare-python-and-code@v1
    plugwise/gh-actions-->>GitHub Actions: Python environment prepared

    GitHub Actions->>plugwise/gh-actions: restore-venv@v1
    plugwise/gh-actions-->>GitHub Actions: venv restored or created
Loading

Possibly related PRs

  • plugwise/python-plugwise#759: Introduced the restore-venv composite action and integrated it into the workflow, which is now being removed or replaced in this PR.

Suggested labels

github_actions

Suggested reviewers

  • bouwew

Poem

A hop and a skip, the venv hops away,
No more custom scripts in the workflow today.
With plugwise actions, our setup is neat,
Python restored in a single heartbeat.
The cache is now handled with elegant flair,
As the rabbit rejoices in streamlined air! 🐇✨

✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch alignci

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 docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests 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 or @coderabbitai title 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.

Copy link

Copy link

codecov bot commented Jun 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (dca4530) to head (93ecb44).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #760   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           21        21           
  Lines         3410      3410           
=========================================
  Hits          3410      3410           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
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: 0

🧹 Nitpick comments (1)
.github/workflows/verify.yml (1)

47-53: Confirm composite action covers checkout & venv setup
The prepare-python-and-code@v1 step replaces your checkout and venv bootstrap. Verify it actually checks out the repo, installs Python, creates ${{ env.VENV }}, and configures pre-commit.

Consider pinning to a full commit SHA for reproducibility.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between dca4530 and 93ecb44.

📒 Files selected for processing (2)
  • .github/actions/restore-venv/action.yml (0 hunks)
  • .github/workflows/verify.yml (9 hunks)
💤 Files with no reviewable changes (1)
  • .github/actions/restore-venv/action.yml
🔇 Additional comments (3)
.github/workflows/verify.yml (3)

68-73: Ensure ruff restore step has all inputs
The ruff job’s restore step only lists python-version; confirm cache-key, venv-dir, and precommit-home aren’t omitted (or rely on safe defaults).


104-112: The remaining restore-venv@v1 invocations across other jobs mirror the pattern reviewed above.

Also applies to: 139-147, 171-178, 217-224, 248-255, 282-289


34-36: ```shell
#!/bin/bash
set -e
echo "Searching for hashFiles usage in .github/workflows/verify.yml"
rg -n "hashFiles" -A2 -B2 .github/workflows/verify.yml || true


</details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

Copy link
Contributor

@bouwew bouwew left a comment

Choose a reason for hiding this comment

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

LGTM!

@bouwew bouwew merged commit ad53115 into main Jun 23, 2025
17 checks passed
@bouwew bouwew deleted the alignci branch June 23, 2025 17:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file enhancement New feature or request quality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants