30 lines
1.1 KiB
Markdown
30 lines
1.1 KiB
Markdown
# Submodules
|
|
|
|
To comply with [client library structure requirement](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/csi-client-structure-proposal.md),
|
|
python client base utilities is moved into the [kubernetes-client/python-base](https://github.com/kubernetes-client/python-base) repo. `git submodules` is being used to handle dependency to that repo.
|
|
This document will provide basic steps to get submodules working.
|
|
|
|
# Clone repo
|
|
|
|
To clone the repo, you need to pass the `recursive` parameter to make the clone also get submodules:
|
|
|
|
```bash
|
|
git clone --recursive https://github.com/kubernetes-client/python.git
|
|
```
|
|
|
|
if you have already cloned the repo with no `--recursive` option, you can run this command to get submodules:
|
|
|
|
```bash
|
|
git submodule update --init
|
|
```
|
|
|
|
# Update submodule
|
|
|
|
If you changed [kubernetes-client/python-base](https://github.com/kubernetes-client/python-base) and want to pull your changes into this repo run this command:
|
|
|
|
```bash
|
|
git submodule update --remote
|
|
```
|
|
|
|
Once updated, you should create a new PR to commit changes to the repository.
|