Rename main
branch to 4.x
and update installation instructions
#29
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This changeset suggests renaming the development branch to
4.x
and adds appropriate installation instructions. In particular, this makes it much easier to install the v4 development version or any version like this:$ composer require react/async:^4@dev $ composer require react/async:"^4@dev || ^3@dev || ^2@dev"
The same branch policy has been suggested for our Promise component via reactphp/promise#212. This is also in line with our existing
3.x
and2.x
branches and means we do not have to update any alias definitions once we would start working on a potential future5.x
.From a consumer's perspective, this means installation is now much easier, as targeting
^4@dev
(or4.x-dev
) is semantically more obvious and safer than usingdev-main
. Additionally, keep in mind that branch names are development artifacts that are subject to change at some point in the future. Once we would decide to rename or delete any of our version branches, the^4@dev
reference would still be valid as it would also match stable versions if we have any^4
tags at this point (which is safe to assume at this point).Once this PR is merged, I will manually rename the
main
branch to4.x
. Unlike suggested in reactphp/promise#212, the default branch should not be changed. In other words,4.x
would be the new default branch, as both3.x
and2.x
are also still under active development.Also refs #14 and #11 for
3.x
and2.x
branch names already used in this project.