kubernetes-client/python
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #245 from mbohlool/doc

Browse Source 
Add basic submodules documentation
This commit is contained in:
Mehdy Bohlool 2017-06-12 02:26:25 -07:00 committed by GitHub
commit e245dbbd32
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
devel/submodules.md Normal file
View File

@ -0,0 +1,27 @@
# Submodules
To comply with [client library structure requirement](https://github.com/kubernetes-client/community/blob/master/design-docs/clients-library-structure.md),
python client base utilities is moved into 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 work.
# Clone repo
To clone repo, you need to pass `recursive` parameter to make the clone also get submodules:
```bash
git clone --recursive https://github.com/kubernetes-incubator/client-python.git
```
if you already clone 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 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.