Skip to content

Commit 409dbce

Browse files
authored
Merge pull request #4 from yunkon-kim/update-submodules
Improve the guide to executing `update-submodules.sh`
2 parents b22a912 + 3901a4a commit 409dbce

File tree

2 files changed

+33
-2
lines changed

2 files changed

+33
-2
lines changed

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,39 @@ If you have any questions or feedback about the Cloud-Migrator, please visit the
9191
9292
Thanks to [the M-CMP Community](https://github.com/m-cmp) for providing this script
9393

94+
### Update submodules
95+
96+
<details>
97+
<summary>Click to see prerequisites</summary>
98+
99+
Prerequisite (before running the script):
100+
- All repositories must have a tag.
101+
- `submodules.md` must be updated and committed.
102+
103+
(Optional) Set your user.name and user.email
104+
```bash
105+
# Set git global user email and name
106+
git config --global user.email "you@example.com"
107+
git config --global user.name "Your Name"
108+
```
109+
110+
(Optional) Update `submodules.md` and commit it
111+
```bash
112+
# Open
113+
vim submodules.md
114+
115+
# Modify repository urls and save
116+
117+
# Commit the updates
118+
git add .
119+
git commit -m "Edit `submodules.md`
120+
```
121+
122+
</details>
123+
124+
125+
Update all submodules:
126+
94127
```bash
95128
# Download the script quietly and save as update-submodules.sh
96129
wget -q -O update-submodules.sh https://raw.githubusercontent.com/m-cmp/m-cmp/main/update-submodules.sh
@@ -101,4 +134,3 @@ chmod 775 update-submodules.sh
101134
# Execute the script
102135
./update-submodules.sh
103136
```
104-

submodules.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
https://github.com/cloud-barista/cm-butterfly
22
https://github.com/cloud-barista/cm-mayfly
3-
https://github.com/cloud-barista/cm-ant
43
https://github.com/cloud-barista/cm-cicada
54
https://github.com/cloud-barista/cm-damselfly
65
https://github.com/cloud-barista/cm-grasshopper

0 commit comments

Comments
 (0)