Skip to content
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

Remove PHP versions from GitHub Actions, fix the documentation link #26

Merged
merged 1 commit into from
Feb 7, 2024

Conversation

msmakouz
Copy link
Member

@msmakouz msmakouz commented Feb 7, 2024

Q A
Bugfix?
Breaks BC?
New feature?

Summary by CodeRabbit

  • Chores
    • Removed the master branch restriction for pushes in GitHub workflows.
    • Adjusted the PHP version configuration in workflow files.
  • Documentation
    • Updated a URL in the README.md documentation section to reflect the correct location for gRPC plugins documentation.

@msmakouz msmakouz added the documentation Improvements or additions to documentation label Feb 7, 2024
@msmakouz msmakouz added this to the 3.2.x milestone Feb 7, 2024
@msmakouz msmakouz requested a review from rustatian February 7, 2024 17:02
@msmakouz msmakouz self-assigned this Feb 7, 2024
Copy link

coderabbitai bot commented Feb 7, 2024

Walkthrough

The recent updates involve loosening the restrictions on workflow triggers by removing the master branch constraint and refining the PHP version setup in GitHub Actions. Additionally, there's an improvement in the project documentation by updating a link to ensure users are directed to the correct, current page for plugin information.

Changes

Files Summary
.github/workflows/phpunit.yml,
.github/workflows/psalm.yml
Removed master branch restriction for pushes and adjusted PHP version configuration.
README.md Updated documentation URL from https://roadrunner.dev/docs/plugins-grpc to https://docs.roadrunner.dev/plugins/grpc.

🐇✨
Changes here and changes there,
Links and versions everywhere.
Through the docs and workflows we hop,
Ensuring our code never does stop.
🌟📜

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@msmakouz msmakouz merged commit 4365f14 into 3.x Feb 7, 2024
4 checks passed
@msmakouz msmakouz deleted the docs branch February 7, 2024 17:03
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.

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 6865691 and b9886ac.
Files ignored due to path filters (1)
  • composer.json is excluded by: !**/*.json
Files selected for processing (3)
  • .github/workflows/phpunit.yml (2 hunks)
  • .github/workflows/psalm.yml (2 hunks)
  • README.md (1 hunks)
Files skipped from review due to trivial changes (2)
  • .github/workflows/phpunit.yml
  • README.md

@@ -1,7 +1,6 @@
on:
push:
branches:
- master
- '*.*'
Copy link

Choose a reason for hiding this comment

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

The branch trigger has been updated to '*.*', which might not behave as intended if the goal was to trigger on all branches. This pattern matches branches with a dot in their names, potentially excluding branches named without dots, such as main or develop.

Consider using '**' to include all branches if that's the intended behavior.

Comment on lines 1 to 6
on:
push:
branches:
- master
- '*.*'
pull_request: null

Copy link

Choose a reason for hiding this comment

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

📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [4-12]

The removal of the PHP version configuration is not directly shown, but its absence could lead to the workflow running on the default PHP version provided by the ubuntu-latest environment. This might not align with the project's PHP version requirements.

Consider specifying the PHP version explicitly or ensuring the default version meets the project's needs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants