gpig 0.0.4 → 0.0.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. data/README.md +29 -30
  2. data/lib/gpig/version.rb +1 -1
  3. metadata +1 -1
data/README.md CHANGED
@@ -1,41 +1,40 @@
1
- GPig
2
- ====
3
-
4
- Usage: gpig <version_file> <git_repo_url>
5
-
6
- This tool helps with gem development. It allows a developer to quickly develop gems by doing the following:
7
-
8
- 1. Increments the version of a gem.
9
- 2. Adds all changed files to the current git repo.
10
- 3. Commits all those changes to the git repo.
11
- 4. Pulls any changes from the repo's origin.
12
- 5. Pushes any changes to the origin.
13
- 6. Runs gem specific_install to install the gem from the git repo URL.
14
-
15
- Assumptions:
16
-
17
- - Your gemspec references a VERSION variable.
18
-
1
+ <h1>GPIG (Git Push Install Gem)</h1>
2
+ <p>Gpig is a nice little tool to help speed up gem development. It does the following:</p>
3
+ <ol>
4
+ <li>Increments the version of a gem.</li>
5
+ <li>Adds all changed files to the current git repo.</li>
6
+ <li>Commits all those changes to the git repo.</li>
7
+ <li>Pulls any changes from the repo's origin.</li>
8
+ <li>Pushes any changes to the origin.</li>
9
+ <li>Runs gem specific_install to install the gem from the git repo URL.</li>
10
+ </ol>
11
+ <p>Usage: <code>gpig [options]</code></p>
12
+ <p>Options:</p>
13
+ <dl>
14
+ <dt><code>--version </code></dt><dd>Shows the currently installed version of gpig.</dd>
15
+ <dt><code>--conf_file </code></dt><dd>The configuration file, defaults to .gpig in the current directory.</dd>
16
+ <dt><code>--increment </code></dt><dd>Whether or not to increment the version, defaults to true.</dd>
17
+ <dt><code>--version_file </code></dt><dd>The version file that holds the VERSION variable that will be incremented.</dd>
18
+ <dt><code>--repo_url </code></dt><dd>The URL of the git repo from which the new gem will be installed.</dd>
19
+ <dt><code>--remote </code></dt><dd>The remote to which the local code changes will be pushed, defaults to origin.</dd>
20
+ <dt><code>--branch </code></dt><dd>The branch to which the local code changes will be committed, defaults to master.</dd>
21
+ <dt><code>--commit_message </code></dt><dd>The message when committing files to the repo, defaults to "More changes".</dd>
22
+ </dl>
23
+ <p>Assumptions:</p>
24
+ <ol>
25
+ <li><p>Your gemspec references a VERSION variable.</p>
19
26
  <pre>
20
27
  Gem::Specification.new do |s|
21
28
  s.name = "gpig"
22
29
  s.version = Gpig::VERSION
23
30
  ...
24
31
  </pre>
25
-
26
- - That VERSION variable is referenced in a version file that you give to gpig.
27
-
32
+ </li>
33
+ <li><p>That VERSION variable is referenced in a version file that you give to gpig.</p>
28
34
  <pre>
29
35
  module Gpig
30
36
  VERSION = '0.0.1'
31
37
  end
32
38
  </pre>
33
-
34
- Example:
35
-
36
- - Create a new gem.
37
- - Make a change.
38
- - Run gpig.
39
- - Test the new version of your gem.
40
- - Repeat :)
41
-
39
+ </li>
40
+ </ol>
@@ -1,3 +1,3 @@
1
1
  module Gpig
2
- VERSION = '0.0.4'
2
+ VERSION = '0.0.7'
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: gpig
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.4
4
+ version: 0.0.7
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors: