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

Fixed composer installation in README.md #1869

Merged
merged 2 commits into from
Feb 10, 2024
Merged

Fixed composer installation in README.md #1869

merged 2 commits into from
Feb 10, 2024

Conversation

Filipponik
Copy link
Contributor

@Filipponik Filipponik commented Feb 10, 2024

Reason for This PR

Docs of installation via composer are incorrect and don't even work (maybe just deprecated)

Description of Changes

Changed from composer require spiral/roadrunner-http spiral/roadrunner-worker nyholm/psr7 to composer require spiral/roadrunner-cli as noted at https://docs.roadrunner.dev/general/install

License Acceptance

By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.

PR Checklist

  • All commits in this PR are signed (git commit -s).
  • The reason for this PR is clearly provided (issue no. or explanation).
  • The description of changes is clear and encompassing.
  • Any required documentation changes (code and docs) are included in this PR.
  • Any user-facing changes are mentioned in CHANGELOG.md.
  • All added/changed functionality is tested.

Summary by CodeRabbit

  • Documentation
    • Updated the composer require command in the README to simplify package installation by including roadrunner-cli.

Copy link
Contributor

coderabbitai bot commented Feb 10, 2024

Walkthrough

The recent update streamlines the package installation process for a project by consolidating the required RoadRunner packages into a single roadrunner-cli package. This change simplifies the setup, reducing the need to include individual packages for HTTP handling, worker management, and PSR-7 implementation.

Changes

File Change Summary
README.md Updated the composer require command to use roadrunner-cli.

🐰🏈

In the field of code, as on the green,

A Rabbit watched the Super Bowl scene.

"Though Chiefs and Niners fiercely play,

In code, we unify today.

With roadrunner-cli, we sprint, no delay!"

🏆🥕

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.

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 7710b9b and f71d349.
Files selected for processing (1)
  • README.md (1 hunks)
Additional comments: 1
README.md (1)
  • 74-74: The updated Composer command aligns with the PR objectives and the official RoadRunner documentation, ensuring users have a simplified and accurate installation process.

@rustatian rustatian self-requested a review February 10, 2024 12:00
@rustatian
Copy link
Member

Hey @Filipponik 👋 Thanks for the PR 👍

These deps are not needed to download the RR binary. The installation process describes how to install RR, not a PHP worker.
The process of creating the PHP Worker is described here: link with all needed deps.

@Filipponik
Copy link
Contributor Author

@rustatian yeah but i wanted to try roadrunner, then i read README.md for install. Installing via composer doesnt work and dont match web docs

@Filipponik
Copy link
Contributor Author

Filipponik commented Feb 10, 2024

i mean composer require spiral/roadrunner-http spiral/roadrunner-worker nyholm/psr7 doesnt create vendor/bin/rr file and cli command in README.md dont work

@rustatian
Copy link
Member

What exactly doesn't match (btw, there is no http and worker deps in the web-docs installation process)?
And what error do you have while installing via compose?

@Filipponik
Copy link
Contributor Author

  1. i see this
    image

  2. i do composer require spiral/roadrunner-http spiral/roadrunner-worker nyholm/psr7, packages succesfully installed

  3. i do ./vendor/bin/rr get-binary and i receive error -bash: ./vendor/bin/rr: No such file or directory

@Filipponik
Copy link
Contributor Author

Filipponik commented Feb 10, 2024

doesn't match:

insallation via composer in web docs:
image

insallation via composer in README.md:
image

Composer command doesnt match

@rustatian
Copy link
Member

Oh yeah, sorry, you're right. Your PR is good to go, it should be cli. Have you tried to install RR via cli (./vendor/bin/rr get)?

@rustatian rustatian added C-enhancement Category: enhancement. Meaning improvements of current module, transport, etc.. A-docs Area: documentation labels Feb 10, 2024
@Filipponik
Copy link
Contributor Author

@rustatian yeah ./vendor/bin/rr ... works after composer require spiral/roadrunner-cli as noted in web docs

@rustatian
Copy link
Member

Cool 👍 LGTM, thanks ❤️

@rustatian rustatian merged commit 5bb3efe into roadrunner-server:master Feb 10, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation C-enhancement Category: enhancement. Meaning improvements of current module, transport, etc..
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants