git_helper 2.0.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9613df3e7ab9cb13b6f955b09d4b128bad3f9cf9a2e8888404c8a3c7a995924
-  data.tar.gz: a7a3341b2cfe6a807b351f0c5c09a889c900ab3c058f5babceb8134f341801c3
+  metadata.gz: 8e4c2767e4d4858d3ed4f8791d0dc82577e9fdf051aff59b1f6516c4f13bd4a4
+  data.tar.gz: 686894c11b437666221793b475cdf81eb1c99437fcc1ee87aef6a3c07d33e9a4
 SHA512:
-  metadata.gz: c5ec564ba24b1af28ce27a74d27a74fecbabd085eab8bdf0fac7b55f31533bdd92077419218829988588f93e8b2df6b4e3138e9a3db2b5073db8d3c435c18df1
-  data.tar.gz: b94d58e9a348fd97635a51c7f42eef77d7bbf7619141b14c07bcc551412de677a7af8e55975a81650bb2127da02e36ab5ec759846fa69d952b831960c7e34e31
+  metadata.gz: 32ba80af9ea352cd22c035ecb5e16c2315bae91c9f2b6b3f49a8d5518ffdc4bd533c9b38e6a8652798bd78672e439ba489d8e58346935f3d43ec21dbc3f248ab
+  data.tar.gz: '093a11e7c9d46548ad0127d31c101a1fcf69e0aba7c7a1e4c1873dbebadb78bb2f3791175c3702b081fb36d788c1bb4cbe0149833ee58180f038269eeb1f2523'

data/README.md

@@ -6,7 +6,7 @@
 gem install git_helper
 ```
 
-Some of the commands in this gem can be used without any additional configuration. However, others utilize special GitHub or GitLab configuration. To provide access tokens for this, create a `~/.git_config.yml` file. The contents should look like this:
+Some of the commands in this gem can be used without any additional configuration. However, others utilize special GitHub or GitLab configuration. To provide access tokens for this, create a `~/.git_helper/config.yml` file. The contents should look like this:
 
 ```
 :github_user: GITHUB-USERNAME
@@ -30,15 +30,22 @@ git-helper --version
 As an additional option, you can set each of the following commands to be a git plugin, meaning you can call them in a way that feels even more git-native:
 
 ```bash
-# As a Gem                              # As a Plugin
-git-helper clean-branches               git clean-branches
-git-helper code-request --create        git code-request --create
+# As a Gem                            # As a Plugin
+git-helper clean-branches             git clean-branches
+git-helper code-request --create      git code-request --create
 ```
 
-To do this, clone this repository from GitHub, and add the following line to your `~/.bash_profile`:
+To do this, download the `plugins.zip` file in the root of this directory. Unzip and place the contents in the appropriate location:
+
+```bash
+mkdir ~/.git_helper
+unzip path/to/downloaded/plugins.zip -d ~/.git_helper
+```
+
+Now, the plugins will live in `~/.git_helper/plugins/*`. Add the following line to your `~/.bash_profile`:
 
 ```
-export PATH=/your/path/to/this/repository/git_helper/plugins:$PATH
+export PATH=/path/to/computer/home/.git_helper/plugins:$PATH
 ```
 
 And then run `source ~/.bash_profile`.
@@ -101,7 +108,7 @@ git-helper clean-branches
 
 ### `code-request`
 
-This command can be used to handily make new GitHub/GitLab pull/merge requests and to merge those requests from the command line. The command uses either the [`Octokit::Client`](https://octokit.github.io/octokit.rb/Octokit/Client.html) or [`Gitlab` client](https://github.com/NARKOZ/gitlab) to do this, so make sure you have a `.git_config.yml` file set up in the home directory of your computer. For instructions on how to do that, see [Gem Usage](#gem-usage).
+This command can be used to handily make new GitHub/GitLab pull/merge requests and to merge those requests from the command line. The command uses either the [`Octokit::Client`](https://octokit.github.io/octokit.rb/Octokit/Client.html) or [`Gitlab` client](https://github.com/NARKOZ/gitlab) to do this, so make sure you have a `~/.git_helper/config.yml` file set up in the home directory of your computer. For instructions on how to do that, see [Gem Usage](#gem-usage).
 
 After setup is complete, you can call the file, and send in a flag indicating whether to create a code request, `-c`, or to merge a code request, `-m`.
 

data/lib/git_helper/git_config_reader.rb

@@ -19,7 +19,7 @@ module GitHelper
     end
 
     private def git_config_file
-      '.git_config.yml'
+      '.git_helper/config.yml'
     end
   end
 end

data/lib/git_helper/version.rb

@@ -1,3 +1,3 @@
 module GitHelper
-  VERSION = '2.0.2'
+  VERSION = '3.0.0'
 end

data/spec/git_helper/git_config_reader_spec.rb

@@ -54,7 +54,7 @@ describe GitHelper::GitConfigReader do
 
     it 'should return the base path with the git config file at the end' do
       allow(Dir).to receive(:pwd).and_return('/Users/firstnamelastname/path/to/git_helper')
-      expect(subject.send(:git_config_file_path)).to eq('/Users/firstnamelastname/.git_config.yml')
+      expect(subject.send(:git_config_file_path)).to eq('/Users/firstnamelastname/.git_helper/config.yml')
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_helper
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Emma Sax
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-10 00:00:00.000000000 Z
+date: 2020-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gitlab
@@ -154,6 +154,7 @@ files:
 - lib/git_helper/octokit_client.rb
 - lib/git_helper/pull_request.rb
 - lib/git_helper/version.rb
+- plugins.zip
 - spec/git_helper/change_remote_spec.rb
 - spec/git_helper/checkout_default_spec.rb
 - spec/git_helper/clean_branches_spec.rb