pr-with-params 0.2.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eba5280a74bea8222e60654a6798ac5cdf60b659a9e085903e0a74a374a900a8
-  data.tar.gz: 78acb1fcda0cd7043fd25e51169365ed66c3ce36616209c8856a569bdf6e76cd
+  metadata.gz: c94c3c4bcc5b4378c7959037b305211a923762986d00bb1428c138dbfb21fef2
+  data.tar.gz: '06238e1b450291ff2b1e2d99e3e49f9f06b81c10e15733782fbaf24adb5c81bf'
 SHA512:
-  metadata.gz: efd0f0b2bc418846d6eb9ca8e37b8c15c03feb77be602e65e811432592108eb22841e8509506050f82f8a1deba547c89eae86ca58d375f38ad0b588d894a621d
-  data.tar.gz: bc35fade6fcf7ddda8ffd4e6ccdaf12e2075060806d326c770b300ccf86a179055a8fe262ad529fc094ae4873156fd72ad7a412877417ded357fa6d7e520d118
+  metadata.gz: 0c39afef5c5af877c513abd50f41c86c05bff19976037b23247f89f941252e7114ae54ae6e3af97e7bda41a0de11419e00f227331231bf3c4bed693bd3b38ffa
+  data.tar.gz: 0242737b9147102086ec22848cb8027160241ff6c7948d237a22c75522e7b095a425771ccedde1b1fb16e1ccd4c7a8ed9aa79575decc0ca4f16b49833761e90c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pr-with-params (0.2.0)
+    pr-with-params (1.0.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,5 +1,7 @@
-# PR::With::Params
-A lightweight gem that pushes current local branch to remote with upstream to origin/[local-branch-name]. It also opens a new browser window at a URL with customized params, based on specified options, which allows to open pull request with pre-populated fields.
+# PR::With::Params [![Gem Version](https://badge.fury.io/rb/pr-with-params.svg)](https://badge.fury.io/rb/pr-with-params)
+A lightweight gem that pushes current local branch to remote with upstream at origin/[local-branch-name]. It also opens a new pull request browser window at a URL with customized query params, based on specified options, which pre-populates certain fields in the pull request. This is especially useful when supporting multiple PR templates within a code base.
+
+Inspired by GitHub's documentation on [using query params to create pull requets](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/using-query-parameters-to-create-a-pull-request)
 
 ## Installation
 
@@ -43,7 +45,8 @@ bug_fix:
 ```
 
 * To run with config file, use `$ pr-with-params --conf='path/to/file.yml' --scope=bug_fix`. If `--scope` option is not specified, only `:default` scope will apply.
-* All your defaults go in the `:default` scope
+* If you specify a config file (`--conf`) and also pass options by flag (e.g `--base-branch=develop`), the flag value will override the config value.
+* All your defaults go in the `:default` scope.
 * Only fields defined in another scope will override the defaults. In the example above, the final list of configs will be:
 
 ```ruby

data/exe/pr-with-params

@@ -56,7 +56,7 @@ begin
   parser.parse!
 
   config_options = PR::With::Params.parse_config(config_file_path, config_scope)
-  options.merge!(config_options)
+  options = config_options.merge(options)
 
   branch_name = `git rev-parse --abbrev-ref HEAD`.chomp
   base_branch = options.delete(:base_branch) || `git remote show origin | grep "HEAD branch" | sed 's/.*: //'`.chomp

data/lib/pr/with/params/version.rb

@@ -3,7 +3,7 @@
 module PR
   module With
     module Params
-      VERSION = "0.2.0"
+      VERSION = "1.0.1"
     end
   end
 end

data/pr-with-params.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["2k-joker"]
   spec.email         = ["kum.vanjunior@gmail.com"]
 
-  spec.summary       = "Pushes current local branch to remote with upstream to origin/[local-branch-name]. It also opens a new browser window at a URL with customized params, based on specified options, which allows to open pull request with pre-populated fields."
+  spec.summary       = "Pushes current local branch to remote with upstream at origin/[local-branch-name]. It also opens a new pull request browser window at a URL with customized query params, based on specified options, which pre-populates certain fields in the pull request. This is especially useful when supporting multiple PR templates within a code base."
   spec.homepage      = "https://github.com/2k-joker/pr-with-params"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pr-with-params
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.1
 platform: ruby
 authors:
 - 2k-joker
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-08 00:00:00.000000000 Z
+date: 2022-08-09 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -56,7 +56,8 @@ requirements: []
 rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
-summary: Pushes current local branch to remote with upstream to origin/[local-branch-name].
-  It also opens a new browser window at a URL with customized params, based on specified
-  options, which allows to open pull request with pre-populated fields.
+summary: Pushes current local branch to remote with upstream at origin/[local-branch-name].
+  It also opens a new pull request browser window at a URL with customized query params,
+  based on specified options, which pre-populates certain fields in the pull request.
+  This is especially useful when supporting multiple PR templates within a code base.
 test_files: []