phpDocumentor / phpDocumentor/guides

[Bug]: Packages incorrectly declare Guides v2 support

Open
#1,315 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

bug triage
Dominant language
PHP
Stars
36
Forks
22
Avg merge
2d 2h
Merged PRs (30d)
24

Description

Summary

A long time ago, the main branch was declared to be 2.x and all packages' composer.json were updated to declare support for v2 versions of the Guides library: 8dace4e48d2b880cb7046afb88cd22af97917f73

Meanwhile, the main branch alias was set back to 1.x in f13722a2cd0be44f0d6807ed21dd4d053e8d00f4, but the composer.json of subpackages still declare support for v2 of the Guides library. See e.g. https://github.com/phpDocumentor/guides/blob/6a008ff1b42f5083e314ce17ae8d4c7129bd92c6/packages/guides-restructured-text/composer.json#L26

This means that, once a Guides 2.x version is released, the restructuredText package 1.9 can be installed together with Guides 2.0. Given no work has started on 2.0 yet, this seems like an unsafe version constraint.

I think the best way forward is to remove the || ^2.0 from all version constraints, and make a note somewhere that the 2.0 versions should have a conflict rule for any Guides sub-package <1.10.0.

Code snippet that reproduces the problem

No response

Expected output

n/a

Contributor guide

Open the contributing guide

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.

Research direction

Start with packages/guides-restructured-text/composer.json and inspect the other subpackage composer.json files for the same Guides dependency constraint. Remove the || ^2.0 ranges, then verify the package manifests consistently target the 1.x line and identify where the 2.0 conflict guidance should be recorded.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
build-system
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.