pull-request 0.6.1 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ec03a95ae507e21ea594a9be05dfd322c9398d2bd79c24880d8bd3436a6a1e4
-  data.tar.gz: dab00856279d92ccc0f28147651a62ace011c97fb2d9305043550bfa6ac1f664
+  metadata.gz: 01ed19f44671d055a29145c6f6c5b240c2dcb84e4cba73b5994e43c7927089aa
+  data.tar.gz: cb019b9929a65728475f17e0621ac5fd9ad5f942144738cacf5d3c145423e632
 SHA512:
-  metadata.gz: 70b786ae43c19db210e9f69dcbc1967b6368e55977b1eca71dd7ec94fbbf552dca60a54afb9c2ecf099b81d8a2c9d16f3ebef03dc765dfa2f9a0ec22a3d1a57b
-  data.tar.gz: a73cb6dcf1c81121a254dd8506053b69b69d20d80dc7f0324518893d5622eaf44db2948d607e865f36718f2f9033f92fe98c4e565b5e1287940ca890f68fbd56
+  metadata.gz: 076fd4a8d39afd3ed4b2d57c485710099f3b078888e9e0051cf6f0dce03c51ebbef91a50be76479beffef94d4517e8804705476745fe81b69bc61bd4f76cc2be
+  data.tar.gz: b0635de9ac9e82b53f3802849ad0a6eb5fe483ba87eacccb5915915c1f0786d8ebd167415feb6ede90121b8f4fc898c40096762c61fc17e2b8097dbd051d1173

data/README.md

@@ -59,6 +59,24 @@ Creates a branch named `feature/create_clients_endpoint` and open a pull-request
 The quotes are optional, but allow `:` and other characters to be a part of the name (otherwise interpreted by the
 shell).
 
+### Additional options
+
+#### Skip PR creation
+
+Use the `--no-pr` (or `-n`) option to create the branch and push it without creating a pull request:
+
+```bash
+pr -n "Create clients endpoint"
+```
+
+#### Specify remote
+
+Use the `--remote` (or `-r`) option to specify a different git remote (defaults to 'origin'):
+
+```bash
+pr -r upstream "Create clients endpoint"
+```
+
 ## Development
 
 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.
@@ -69,6 +87,17 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/Jens Ravens/pullrequest. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
+## Troubleshooting
+
+**No such file or directory**
+ 
+```
+pr -i 210
+pr: cannot open 210, No such file or directory
+```
+
+`pr` is already a command on the OS, until we override it with our GEM. If encountering this error it means that the gem has not been installed successfully for this Ruby version.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/exe/pr

@@ -2,9 +2,12 @@
 require "optionparser"
 require "active_support"
 require "active_support/all"
+require "shellwords"
 
 @simulate = false
 @issue_number = nil
+@skip_pr = false
+@remote = "origin"
 
 def error(title)
   STDERR.puts title
@@ -49,6 +52,12 @@ OptionParser.new do |opts|
   opts.on("-i", "--issue ISSUE_NUMBER", Integer, "Create a pull-request fixing an issue with the provided number.") do |i|
     @issue_number = i
   end
+  opts.on("-n", "--no-pr", "Skip creating the pull request on GitHub") do
+    @skip_pr = true
+  end
+  opts.on("-r", "--remote REMOTE_NAME", "Specify the git remote name (default: origin)") do |remote|
+    @remote = remote
+  end
 end.parse!
 
 name = @issue_number ? issue_json["title"] : ARGV.join(" ")
@@ -64,7 +73,6 @@ body_lines = []
 path = ".github/pull_request_template.md"
 body_lines.push File.read(path) if File.exist?(path)
 body_lines.push "fixes ##{@issue_number}" if @issue_number
-body = body_lines.join("\n\n")
 
 base_branch = current_branch
 exit 1 unless ["master", "main", "develop"].include?(base_branch) || confirm("Your base branch #{base_branch} doesn't seem to be a common base branch name. Do you want to continue?")
@@ -77,11 +85,12 @@ sh "git checkout -b #{branch}"
 puts "Creating empty commit"
 commit_message = "initial commit for #{title}"
 commit_message += ", fixes ##{@issue_number}" if @issue_number
-sh "git commit -m '#{commit_message}' --allow-empty"
+sh "git commit -m #{Shellwords.escape(commit_message)} --allow-empty"
 
-puts "Pushing to origin"
-sh "git push -u origin #{branch}"
+puts "Pushing to #{@remote}"
+sh "git push -u #{@remote} #{branch}"
 
-puts "Creating pull request"
-ENV["PR_BODY"] = body_lines.join("\n")
-sh "gh pr create --draft --title '#{title}' --body \"$PR_BODY\" --base #{base_branch}"
+unless @skip_pr
+  puts "Creating pull request"
+  sh "gh pr create --draft --title #{Shellwords.escape(title)} --body #{Shellwords.escape(body_lines.join("\n"))} --base #{base_branch}"
+end

data/pullrequest.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   spec.name          = "pull-request"
-  spec.version       = "0.6.1"
+  spec.version       = "0.6.3"
   spec.authors       = ["Jens Ravens", "David Dufour-Boivin"]
   spec.email         = ["jens@nerdgeschoss.de", "david@nerdgeschoss.de"]
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: pull-request
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.3
 platform: ruby
 authors:
 - Jens Ravens
 - David Dufour-Boivin
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-14 00:00:00.000000000 Z
+date: 2025-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -53,7 +53,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - jens@nerdgeschoss.de
 - david@nerdgeschoss.de
@@ -79,7 +79,7 @@ homepage: https://nerdgeschoss.de
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.7
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Automatically create PRs for GitHub Flow
 test_files: []