subrepos

The package manager for subrepositories (submodules).

Install

npm install -g subrepos
# or
yarn global add subrepos

Usage

For using subrepos you need to create the subrepos.yml file inside the root directory. The example content of subrepos.yml:

# Repository 1
- name: fiddle
  directory: vendor/fiddle
  commit: 8e92183de2b91b2727cc7408bb43987f264c2b37
  url: https://github.com/electron/fiddle.git
# Repository 2, with default branch and commit
- name: edis
  directory: some/other/dir/edis
  url: https://github.com/siberianmh/electron-discord.git
# Repository 3, wtih non-default branch
- name: VSCode
  directory: source/vscode
  commit: 5763d909d5f12fe19f215cbfdd29a91c0fa9208a
  url: https://github.com/microsoft/vscode
  branch: release/1.45

The directory used to provide a folder where the content of provided repository is being cloned, commit is the commit in repository to which be reverted, url the repository url. After providing these fields you can run subrepos install to install sub repositories.

After running subrepos install you also need to update .gitignore, since the cloned repository is fully accessible and can be modified (e.g. commiting, branch changing).

Commands

subrepos or subrepos install

Install the subrepositories.

License

MIT