Package org.eclipse.jgit.gitrepo

Class RepoCommand

  • All Implemented Interfaces:
    Callable<RevCommit>
    public class RepoCommand
extends GitCommand<RevCommit>
    A class used to execute a repo command. This will parse a repo XML manifest, convert it into .gitmodules file and the repository config file. If called against a bare repository, it will replace all the existing content of the repository with the contents populated from the manifest. repo manifest allows projects overlapping, e.g. one project's manifestPath is "foo" and another project's manifestPath is "foo/bar". This won't work in git submodule, so we'll skip all the sub projects ("foo/bar" in the example) while converting.
    Since:
    3.4
    See Also:
    git-repo project page

    • Constructor Detail

      • RepoCommand

        public RepoCommand​(Repository repo)
        Constructor for RepoCommand
        Parameters:
        repo - the Repository

    • Method Detail

      • setInputStream

        public RepoCommand setInputStream​(InputStream inputStream)
        Set the input stream to the manifest XML.

        Setting inputStream will ignore the path set. It will be closed in call().

        Parameters:
        inputStream - a InputStream object.
        Returns:
        this command
        Since:
        3.5

      • setURI

        public RepoCommand setURI​(String uri)
        Set base URI of the paths inside the XML. This is typically the name of the directory holding the manifest repository, eg. for https://android.googlesource.com/platform/manifest, this should be /platform (if you would run this on android.googlesource.com) or https://android.googlesource.com/platform elsewhere.
        Parameters:
        uri - the base URI
        Returns:
        this command

      • setTargetURI

        public RepoCommand setTargetURI​(String uri)
        Set the URI of the superproject (this repository), so the .gitmodules file can specify the submodule URLs relative to the superproject.
        Parameters:
        uri - the URI of the repository holding the superproject.
        Returns:
        this command
        Since:
        4.8

      • setGroups

        public RepoCommand setGroups​(String groups)
        Set groups to sync
        Parameters:
        groups - groups separated by comma, examples: default|all|G1,-G2,-G3
        Returns:
        this command

      • setBranch

        public RepoCommand setBranch​(String branch)
        Set default branch.

        This is generally the name of the branch the manifest file was in. If there's no default revision (branch) specified in manifest and no revision specified in project, this branch will be used.

        Parameters:
        branch - a branch name
        Returns:
        this command

      • setTargetBranch

        public RepoCommand setTargetBranch​(String branch)
        Set target branch.

        This is the target branch of the super project to be updated. If not set, default is HEAD.

        For non-bare repositories, HEAD will always be used and this will be ignored.

        Parameters:
        branch - branch name
        Returns:
        this command
        Since:
        4.1

      • setRecordRemoteBranch

        public RepoCommand setRecordRemoteBranch​(boolean enable)
        Set whether the branch name should be recorded in .gitmodules.

        Submodule entries in .gitmodules can include a "branch" field to indicate what remote branch each submodule tracks.

        That field is used by "git submodule update --remote" to update to the tip of the tracked branch when asked and by Gerrit to update the superproject when a change on that branch is merged.

        Subprojects that request a specific commit or tag will not have a branch name recorded.

        Not implemented for non-bare repositories.

        Parameters:
        enable - Whether to record the branch name
        Returns:
        this command
        Since:
        4.2

      • setRecordSubmoduleLabels

        public RepoCommand setRecordSubmoduleLabels​(boolean enable)
        Set whether the labels field should be recorded as a label in .gitattributes.

        Not implemented for non-bare repositories.

        Parameters:
        enable - Whether to record the labels in the .gitattributes
        Returns:
        this command
        Since:
        4.4

      • setRecommendShallow

        public RepoCommand setRecommendShallow​(boolean enable)
        Set whether the clone-depth field should be recorded as a shallow recommendation in .gitmodules.

        Not implemented for non-bare repositories.

        Parameters:
        enable - Whether to record the shallow recommendation.
        Returns:
        this command
        Since:
        4.4

      • setIgnoreRemoteFailures

        public RepoCommand setIgnoreRemoteFailures​(boolean ignore)
        Set whether to skip projects whose commits don't exist remotely.

        When set to true, we'll just skip the manifest entry and continue on to the next one.

        When set to false (default), we'll throw an error when remote failures occur.

        Not implemented for non-bare repositories.

        Parameters:
        ignore - Whether to ignore the remote failures.
        Returns:
        this command
        Since:
        4.3

      • setAuthor

        public RepoCommand setAuthor​(PersonIdent author)
        Set the author/committer for the bare repository commit.

        For non-bare repositories, the current user will be used and this will be ignored.

        Parameters:
        author - the author's PersonIdent
        Returns:
        this command

      • addToDestination

        public RepoCommand addToDestination​(String path,
                                    String contents)
        Create a file with the given content in the destination repository
        Parameters:
        path - where to create the file in the destination repository
        contents - content for the create file
        Returns:
        this command
        Since:
        6.1