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

Fix documentation links #23

Merged
merged 1 commit into from
Feb 7, 2024
Merged

Fix documentation links #23

merged 1 commit into from
Feb 7, 2024

Conversation

msmakouz
Copy link
Member

@msmakouz msmakouz commented Feb 7, 2024

Summary by CodeRabbit

  • Chores
    • Updated the GitHub Actions workflow to run PHPUnit tests on all branches.
    • Modified the Psalm analysis workflow to trigger on push events for all branches and removed PHP version restriction.

@msmakouz msmakouz added the documentation Improvements or additions to documentation label Feb 7, 2024
@msmakouz msmakouz self-assigned this Feb 7, 2024
Copy link

coderabbitai bot commented Feb 7, 2024

Walkthrough

The recent updates to the repository's GitHub Actions workflows broaden the scope of automated testing and code analysis. The phpunit workflow has been adjusted to activate across all branches that carry any version number, ensuring comprehensive testing beyond the master branch. Simultaneously, the psalm workflow has been refined to trigger without branch or PHP version constraints, promoting a more flexible approach to static code analysis.

Changes

File Path Change Summary
.github/.../phpunit.yml Modified to run on all versioned branches, previously limited to master.
.github/.../psalm.yml Removed branch and PHP version restrictions for push events.

🐇✨
In a burrow deep and wide,
Code changes flow like the tide.
Tests and analysis far and wide,
Ensuring quality with every stride.
🌟🐾

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 945a234 into 4.x Feb 7, 2024
7 checks passed
@msmakouz msmakouz deleted the docs branch February 7, 2024 17:48
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 a5d6744 and 5d4ea04.
Files ignored due to path filters (1)
  • composer.json is excluded by: !**/*.json
Files selected for processing (2)
  • .github/workflows/phpunit.yml (1 hunks)
  • .github/workflows/psalm.yml (2 hunks)
Files skipped from review due to trivial changes (1)
  • .github/workflows/psalm.yml
Additional comments: 1
.github/workflows/phpunit.yml (1)
  • 4-5: The branches trigger pattern '*.*' effectively broadens the scope to include all branches with a version number format. Verify this pattern aligns with the project's branching strategy to ensure it doesn't inadvertently trigger workflows on unintended branches.

.github/workflows/phpunit.yml Show resolved Hide resolved
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