git-sbm 0.2.1 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +33 -15
- data/lib/submodule/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0e3a8472c8344886a029b9205aba3a14d89e288b9691b25ee966ee7a1fe0ddea
|
4
|
+
data.tar.gz: 35487d2b246d666bf40ce54d06dfcf83a7b610143ef8872f24b5a27ac91599f3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d37090e24e04ac1d2fd9794bdd35e173ee3835c49fac42b370e0e20cdb9984ff77079ea366c3d11b5edbc27e645bb45c4fcb3e6263837cfe97e4dbc2d4062ca6
|
7
|
+
data.tar.gz: cf7e523995121b2109860178867e43928339abf30bada4882010a564a3808b3e7832987803209ae7c95bcdc2375c056bd35dda5029f1409f63d06f5e761a953c
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -1,35 +1,53 @@
|
|
1
|
-
#
|
1
|
+
# Git-Submodules
|
2
2
|
|
3
|
-
Welcome to
|
4
|
-
|
5
|
-
TODO: Delete this and the text above, and describe your gem
|
3
|
+
Welcome to Git-Submodules!
|
4
|
+
Git-Submodules is a simple tool with the goal of making your workflow with submodules a little bit easier.
|
6
5
|
|
7
6
|
## Installation
|
8
7
|
|
9
|
-
Add
|
8
|
+
The recommended way of installing is through Bundler. Add the following to your Gemfile:
|
10
9
|
|
11
10
|
```ruby
|
12
|
-
gem '
|
11
|
+
gem 'git-sbm'
|
13
12
|
```
|
14
13
|
|
15
14
|
And then execute:
|
16
15
|
|
17
|
-
$ bundle
|
16
|
+
$ bundle install
|
18
17
|
|
19
|
-
|
18
|
+
## Usage
|
20
19
|
|
21
|
-
|
20
|
+
### Initializing
|
21
|
+
When first integrating Git-Submodules to your project run the following command:
|
22
22
|
|
23
|
-
|
23
|
+
`$ bundle exec git-sbm init`
|
24
|
+
|
25
|
+
This way the dependencies folder will be created. That's the folder where your submodules will be checked out. All the following commands should run from the "Dependencies" parent folder from now on.
|
26
|
+
|
27
|
+
### Adding a dependency
|
28
|
+
To add a dependency just run
|
29
|
+
|
30
|
+
`$ bundle exec git-sbm add <dependecy name> <submodule url>`
|
31
|
+
|
32
|
+
### Update a dependency to a specific version
|
33
|
+
To set a dependency to a specific version run
|
34
|
+
|
35
|
+
`$ bundle exec git-sbm update <dependecy name> <version tag>`
|
36
|
+
|
37
|
+
This will create a commit with the update
|
38
|
+
|
39
|
+
### Sync dependencies
|
40
|
+
To sync your dependencies just run
|
24
41
|
|
25
|
-
|
42
|
+
`$ bundle exec git-sbm boot`
|
26
43
|
|
27
|
-
|
44
|
+
You should run this command after you cloned a git repo that has submodules (e.g on your C.I.), when someone in your team update a dependency or change the remote url
|
28
45
|
|
29
|
-
|
46
|
+
### Remove dependency
|
47
|
+
To remove a dependency just run
|
30
48
|
|
31
|
-
|
49
|
+
`$ bundle exec git-sbm remove <dependecy name>`
|
32
50
|
|
33
51
|
## Contributing
|
34
52
|
|
35
|
-
Bug reports and pull requests are welcome on GitHub at https://github.com/
|
53
|
+
Bug reports and pull requests are welcome on GitHub at [rcarvalhosilva/git-submodules](https://github.com/rcarvalhosilva/git-submodules)
|
data/lib/submodule/version.rb
CHANGED