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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6e6a784dcec5dd3ac435ee2ed4839ba2a4df053693171b266aeb0a3001f02d59
4
- data.tar.gz: 6b501f23e90d951492dfd76d09ae629e97d057e7161f24ac6916d8ef412a4e27
3
+ metadata.gz: 0e3a8472c8344886a029b9205aba3a14d89e288b9691b25ee966ee7a1fe0ddea
4
+ data.tar.gz: 35487d2b246d666bf40ce54d06dfcf83a7b610143ef8872f24b5a27ac91599f3
5
5
  SHA512:
6
- metadata.gz: 378228c505022f94e7ef419a07d5e5b53f66a9ccc05b98c79e5fe12fa874bcf265492545604f0795547d45666feea58396ed2765f20c871086cfb19812ff3be9
7
- data.tar.gz: 518299bffeade188bfbd529d7db6d0d8941fe15635ad30bee0191634c7e281b36c918f38da7b3386b0143af5592b1ad0e2f7ea09221086b9132bdeb9252c69a6
6
+ metadata.gz: d37090e24e04ac1d2fd9794bdd35e173ee3835c49fac42b370e0e20cdb9984ff77079ea366c3d11b5edbc27e645bb45c4fcb3e6263837cfe97e4dbc2d4062ca6
7
+ data.tar.gz: cf7e523995121b2109860178867e43928339abf30bada4882010a564a3808b3e7832987803209ae7c95bcdc2375c056bd35dda5029f1409f63d06f5e761a953c
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- git-sbm (0.2.1)
4
+ git-sbm (0.2.2)
5
5
  fileutils
6
6
  thor
7
7
 
data/README.md CHANGED
@@ -1,35 +1,53 @@
1
- # Submodule
1
+ # Git-Submodules
2
2
 
3
- Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/submodule`. To experiment with that code, run `bin/console` for an interactive prompt.
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 this line to your application's Gemfile:
8
+ The recommended way of installing is through Bundler. Add the following to your Gemfile:
10
9
 
11
10
  ```ruby
12
- gem 'submodule'
11
+ gem 'git-sbm'
13
12
  ```
14
13
 
15
14
  And then execute:
16
15
 
17
- $ bundle
16
+ $ bundle install
18
17
 
19
- Or install it yourself as:
18
+ ## Usage
20
19
 
21
- $ gem install submodule
20
+ ### Initializing
21
+ When first integrating Git-Submodules to your project run the following command:
22
22
 
23
- ## Usage
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
- TODO: Write usage instructions here
42
+ `$ bundle exec git-sbm boot`
26
43
 
27
- ## Development
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
- After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
46
+ ### Remove dependency
47
+ To remove a dependency just run
30
48
 
31
- To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
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/[USERNAME]/submodule.
53
+ Bug reports and pull requests are welcome on GitHub at [rcarvalhosilva/git-submodules](https://github.com/rcarvalhosilva/git-submodules)
@@ -1,3 +1,3 @@
1
1
  module Submodule
2
- VERSION = "0.2.1"
2
+ VERSION = "0.2.2"
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: git-sbm
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.1
4
+ version: 0.2.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Rodrigo Carvalho