mpmAddRepository

Add repository to repository list

Since R2024b

collapse all in page

    Syntax

    mpmAddRepository(repoName,repoLocation)
    mpmAddRepository(repoObj)
    mpmAddRepository(___,Position=repoPos)
    repo = mpmAddRepository(___)

    Description

    mpmAddRepository(repoName,repoLocation) adds the specified location to the MATLAB® repository list and gives the repository the specified name.

    The function adds repositories to the end of the MATLAB repository list by default. If the specified repository is already on the repository list, then the function does not reorder the repositories.

    example

    mpmAddRepository(repoObj) moves the repository identified the repository identified by the specified matlab.mpm.Repository object to the end of the repository list.

    mpmAddRepository(___,Position=repoPos) adds the repository to the repository list at the specified position. Specify repoPos as "begin" or "end" in addition to any of the input argument combinations in previous syntaxes.

    MATLAB searches each repository on the known repository list in order. If a repository has multiple packages that meet these conditions, then MATLAB selects the package with the latest semantic version. Once a package that meets the conditions has been found, other repositories on the list of known repositories are not searched.

    example

    repo = mpmAddRepository(___) returns a matlab.mpm.Repository object that represents the added repository.

    Examples

    collapse all

    Add the folder C:\MyCode\MyPackageRepository to the repository list and name it "My Repository".

    mpmAddRepository("My Repository","C:\MyCode\MyPackageRepository")

    Add the folder C:\MyCode\MyPackageRepository to the beginning of the repository list.

    repo = mpmAddRepository("MyRepo","C:\MyCode\MyPackageRepository",Position="beginning")
    repo = 

  Repository with properties:

        Name: "MyRepo"
    Location: "C:\MyCode\MyPackageRepository"

    Input Arguments

    collapse all

    Repository name, specified as a string array, character vector, or cell array of character vectors.

    Repository location, specified as a string array, character vector, or cell array of character vectors where each element contains the location to be added to the MATLAB repository list.

    Repository object, specified as a matlab.mpm.Repository array.

    Repository list position, specified as one of these values:

    • "end" — Add the repository to the end of the repository list.

    • "begin" — Add the repository to the beginning of the repository list.

    MATLAB searches each repository on the known repository list in order. If a repository has multiple packages that meet these conditions, then MATLAB selects the package with the latest semantic version. Once a package that meets the conditions has been found, other repositories on the list of known repositories are not searched.

    Tips

    • It is recommended to make sure a package's Authoring property is 0 or false before adding the folder containing that package as a repository.

    Version History

    Introduced in R2024b

    See Also

    Objects

    Functions

    Topics