[Chore] The Workerman minimum version ^5.0 is lower than what the code and docs need

Closed
#993 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
55/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Active
Tech stack
php, symfony
Domain
build-system

Research direction

Start by comparing the Workerman constraint in composer.json with the version used by CI and the lock file, then review the version-specific notes in docs/deployment.md and docs/logging-monitoring.md. Decide whether to raise the minimum version or add a lowest-version CI job; completion means the chosen path is reflected in the required files and the documented 5.1.4 caveats are removed if Option A is selected.

Written by the indexing model from the issue text.

Description

priority:low type:chore

Problem

composer.json:43 allows workerman/workerman: ^5.0.
But some things in the code and docs need a newer version:

  • The 10 MB log cut (Worker::$logFileMaxSize) exists only from Workerman 5.1.4. docs/deployment.md and docs/logging-monitoring.md now say this.
  • CI and the lock file test only Workerman 5.2.2.

So a user can install 5.0.x. Then the bundle may behave in a way that the docs do not describe, and no test checks it.

Fix idea

Option A: raise the minimum to ^5.1.4 or ^5.2 (the version that CI tests).
Option B: keep ^5.0 and add a CI job with composer update --prefer-lowest.

Option A is simpler. It changes what users can install, so it needs a CHANGELOG and an UPGRADE.md note.

Done when

  • A decision: A or B.
  • composer.json, CHANGELOG and UPGRADE.md are updated (A), or the lowest-version CI job is green (B).
  • The docs do not need "only from 5.1.4" notes anymore (A).
Dominant language
PHP
Stars
2
Forks
3
Avg merge
1d 20h
Merged PRs (30d)
52

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from crazy-goat/workerman-bundle

All issues in crazy-goat/workerman-bundle

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.