Shulou(Shulou.com)06/02 Report--

What this article shares with you is about the reasons for using aliases. The editor thinks it is very practical, so share it with you as a reference and follow the editor to have a look.

The following composer tutorial column to introduce you to the reasons for the use of branch aliases, I hope to help friends in need!

Why use aliases?

When you use the version control system repository, you can only get a comparable version from branches that look like versions, such as 2.0 or 2.0.x. For master branches, you can only get one dev-master version. For the bugfix branch, you will get the dev-bugfix version.

If your master branch is used to mark 1.0 development processes, such as 1.0.1, 1.0.2, 1.0.3, etc., packages that depend on your library may need 1.0.*.

If someone wants to use the latest dev-master, there will be a problem: some packages may need 1.0.*, so the two will cause a conflict because the dev-master does not match 1.0.*.

Based on the above, aliases appear.

Branch alias

The dev-master branch is one of the main VCS repositories. It is common for some people to want the latest main development version. Therefore, Composer allows you to alias the dev-master branch as the 1.0.x-dev version. It is done by specifying the branch-alias field under extra in composer.json:

{"extra": {"branch-alias": {"dev-master": "1.0.x-dev"}

If the alias is an incomparable version (for example, dev-develop), you must add the prefix dev- to the branch name. You can also add aliases (that is, start with a number and end with A. x-dev) for comparable versions, but only as more specific versions. For example, 1.x-dev can be aliased as 1.2.x-dev.

The alias must be a comparable development version, and the branch-alias must appear on the branch it references. For dev-master, you need to submit it on the master branch.

As a result, a lot of people now need 1.0.* and he will be happy to install dev-master.

To use a branch alias, you must have a repository of packages with aliases. If you want to add an alias to a third-party package without maintaining its branches, use inline aliases, as described below.

Inline alias required

Branch aliases are useful for major development lines. But in order to use them, you need to control the source repository and commit changes to version control.

This is not very interesting when you want to try bug fixes for a library, which is a dependency of a local project.

Therefore, you can alias the package in the require and require-dev field. Suppose you find an error in the monolog/monolog package. You cloned Monolog on GitHub and solved this problem in a branch called bugfix. Now you will install this version of monolog in your local project.

You are using symfony/monolog-bundle and need monolog/monolog version 1.*. Therefore, you need to use dev-bugfix to match the constraint.

Add it to the root composer.json of the project:

{"repositories": [{"type": "vcs", "url": "https://github.com/you/monolog"}]," require ": {" symfony/monolog-bundle ":" 2.0 "," monolog/monolog ":" dev-bugfix as 1.0.x-dev "}}

This will get the dev-bugfix version of monolog/monolog from your Github and alias it as 1.0.x-dev.

Note: inline aliases are a feature limited to root users. If you need a package with an inline alias, use the alias (to the right of as) as a version constraint. The left part of the as is discarded. Therefore, if A requires B and B need the monolog/monolog version dev-bugfix to be 1.0.x-dev, then installing A will also cause B to require 1.0.x-dev, which may exist as a branch alias or as an actual 1.0 branch. If not, the alias must be inlined again in the composer.json of A.

Note: inline aliases should be avoided, especially for released packages / libraries. If you find an error, try merging your fix upstream, which helps avoid problems with users using your package.

Thank you for reading! This is the end of this article on "reasons for using aliases". I hope the above content can be of some help to you, so that you can learn more knowledge. if you think the article is good, you can share it for more people to see!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.