master_to_main 0.0.2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a64928607b005c31d0d4ad4e01994c12733d5744bd75d72fcf9e3d58279be81
-  data.tar.gz: 2b72700b70c3d2f07ca291e3b18e0d147fbf1e4ae5636ba124af0d522bed8db1
+  metadata.gz: c946d54f9f02e3fd4b826f9293f2d46d5c5ea6bd92d375976e56f7b30539c09f
+  data.tar.gz: dfb3ee1e58e811d8d265bca117b1ac4ca468ad3ea610f422a90199c1e71e9d90
 SHA512:
-  metadata.gz: 76c82db75d6c0157219f6700bebdf6b81d48e3a0954da7ebde4e31c051282e463935e4d3c377a37dc2424ffd909a5e7757c1e106256ec4bf8bce87da1e229a46
-  data.tar.gz: 6af1841e036951b0f8a2f8ed37e4477d7f8d9ffda9b99a93b121de43e215a32567f36488256f2d6696ca183ffac142278e59e7842817724fecc7330c1e3c29fd
+  metadata.gz: 0c4472188bf291848ee7ccdade125d7b442cbb698617942ba3dff93b9d9a8e44ecfba597401fa0f561e1b785e1aded3b1157db9a821af25e4e54ab72b7d3bc23
+  data.tar.gz: cc81f28a699618888e1d8f0b79abfac319ad8fdf47ba815f4841030bbf5a495856caf9a2904bb457f9473eaaed34c41b78669b1cfa1532907f5ec1fad3a0c67e

data/CHANGELOG.md

@@ -1,4 +1,33 @@
-# 0.0.1 - 2020-06-17
+# 0.0.7 - 2020-06-24
+
+- Remove forgotten pry requirement
+- Don't update md files in `vendor/` (thanks @woodbusy)
+- Readme clarification (thanks @woodbusy)
+
+# 0.0.6 - 2020-06-23
+
+- Include `find_references` in `update_docs`
+- README Updates
+
+# 0.0.5 - 2020-06-19
+
+- Add `find_references` for finding non doc references
+- Provide better explanation that you are updating docs only
+- Rescue from branch protection errors like in personal private repos
+
+# 0.0.4 - 2020-06-18
+
+- Change `github` to `update`
+- Add `update_docs` command
+
+# 0.0.3 - 2020-06-17
+
+- Only set api endpoint if not using "github.com"
+- Bump rake version
+- Typos
+- Fetch before checking out main
+
+# 0.0.2 - 2020-06-17
 
 Fix checkout of local branch, add local master branch deletion
 

data/CONTRIBUTORS.md

@@ -0,0 +1 @@
+- [@woodbusy](https://github.com/woodbusy)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    master_to_main (0.1.0)
+    master_to_main (0.0.7)
       octokit (~> 4.0)
       thor (~> 1.0.1)
 
@@ -18,7 +18,7 @@ GEM
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     public_suffix (4.0.5)
-    rake (10.5.0)
+    rake (13.0.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -41,7 +41,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (~> 2.0)
   master_to_main!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -4,29 +4,49 @@
 enterprise to a new branch. For example, if you wanted to change `master` to
 `main`.
 
+While `master` does have meanings that connote expertise or original record, it also
+has meanings that have much more oppressive and violent histories. Whether or not the
+original meaning of `master` branch was in reference to original record or the opposite
+of slave matters less than what it may mean to a reader who doesn't want to bother with
+the history of git.
+
+Per the twitter thread below, maybe we can just think of it as:
+
+> Agreed. All it does is make the world a tiny bit more welcoming.
+
 Thanks to [@shanselman](https://github.com/shanselman) for [the
 suggestion](https://twitter.com/shanselman/status/1269838158650195968).
 
+## Installation
+
+You need ruby and [rubygems](https://rubygems.org/pages/download) to use `master_to_main`.
+With ruby gems installed you can simply run
+
+```
+$ gem install master_to_main
+```
+
 ## Functionality
 
-`MasterToMain` has 2 actions for now:
+`MasterToMain` has 3 actions:
 
-1. `github`
-2. `update_local`
+1. `update` - Update github, pull requests, branch protections, local origin
+1. `update_local` - For people to use after `update` to update the local clone
+1. `update_docs` - If you just want to search docs for github urls.
 
-## Github
+## `update`
 
 ### Usage
 
 ```
-master_to_main github
+master_to_main update
 ```
 
 After filling out the relevant prompts you will be able to:
 
 1. Create a new branch (e.g. `main`) if it does not exist.
 1. Clone all branch protections from an old branch.
-  - Caveat: This does not include the signed commit requirement
+   - Caveat: This does not include the signed commit requirement
 1. Change the default branch of your repository
 1. Rebase all pull requests based on your old branch to your new branch
 1. Change the local `origin` remote value in github.
@@ -40,8 +60,11 @@ on Fetch URL of `origin` or "github.com")
 or `pwd`)
 1. The current default branch (default is `master`)
 1. The desired default branch (default is `main`)
+1. Your personal access token (instructions for settings one can be found [here](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line))
+   - You should enable "repo" access
 
-## Update Local Clone
+
+## `update_local`
 
 ### Usage
 
@@ -63,22 +86,16 @@ $ git symbolic-ref refs/remotes/origin/HEAD refs/remotes/origin/main
 All credit for this goes to "Brad from XUnit.net!" per [Scott's
 Blog](https://www.hanselman.com/blog/EasilyRenameYourGitDefaultBranchFromMasterToMain.aspx).
 
+## `update_docs`
 
-## Installation
-
-Add this line to your application's Gemfile:
+### Usage
 
-```ruby
-gem 'master_to_main'
+```
+master_to_main update_docs
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install master_to_main
+This will attempt to update all references to commits on the master branch with
+commits on the main branch.
 
 ## TODO
 
@@ -86,7 +103,7 @@ Or install it yourself as:
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/master_to_main. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/dewyze/master_to_main. 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.
 
 ## Code of Conduct
 

data/lib/master_to_main/cli.rb

@@ -3,13 +3,14 @@ require "octokit"
 
 module MasterToMain
   class CLI < Thor
+    include Thor::Actions
+
     def self.exit_on_failure?
       true
     end
 
-    desc "github", "rebase PRs to the main branch"
-    def github
-
+    desc "update", "rebase PRs to the main branch"
+    def update
       prompt_info
       create_client
 
@@ -20,6 +21,21 @@ module MasterToMain
       rebase_pull_requests
       change_origin
       delete_local_old_branch
+      ask_update_docs
+      ask_find_references
+    end
+
+    desc "update_docs", "update local docs to use MAIN"
+    def update_docs
+      prompt_info
+      _update_docs
+      ask_find_references
+    end
+
+    desc "find_references", "find references to github urls with MAIN"
+    def find_references
+      prompt_info
+      _find_references
     end
 
     desc "update_local", "point local clone to new branch"
@@ -32,12 +48,15 @@ module MasterToMain
       `git branch --unset-upstream`
       `git branch -u origin/#{@repo.new_branch}`
       `git symbolic-ref refs/remotes/origin/HEAD refs/remotes/origin/#{@repo.new_branch}`
+      `git pull`
     end
 
     no_commands do
       def create_client
-        Octokit.configure do |c|
-          c.api_endpoint = @repo.api_endpoint
+        if @repo.github != "github.com"
+          Octokit.configure do |c|
+            c.api_endpoint = @repo.api_endpoint
+          end
         end
         token = ask("What is your GitHub Personal Access Token?")
 
@@ -55,7 +74,7 @@ module MasterToMain
           {
             github: "github." + github_suffix,
             user: user,
-            repo: repo.chomp,
+            repo: repo.gsub(/\.git/, "").chomp,
           }
         else
           {
@@ -69,8 +88,8 @@ module MasterToMain
       def prompt_info
         github_info = get_github_info
         github_url = ask("What is your github url?", default: github_info[:github]).gsub(/https:\/\//, "")
-        user = ask("What is your github user?", default: github_info[:user])
-        github_repo = ask("What is your github repo?", default: github_info[:repo])
+        user = ask("What is the repo's parent user/organization?", default: github_info[:user])
+        github_repo = ask("What is your github repo?", default: github_info[:repo]).gsub(/\.git/, "")
         old_branch = ask("What is your current primary branch?", default: "master")
         new_branch = ask("What is your desired primary branch?", default: "main")
 
@@ -80,7 +99,7 @@ module MasterToMain
       def ensure_old_branch_exists
         @client.branch(@repo.name, @repo.old_branch)
       rescue Octokit::NotFound
-        say "The current primary branch does not exist, or do you not have access. Was there a typo?", :red
+        say "The current primary branch does not exist, or you do not have access. Was there a typo?", :red
         say "-----------------------"
         say "CURRENT PRIMARY BRANCH: #{@repo.old_branch}", :green
         exit 1
@@ -113,7 +132,12 @@ module MasterToMain
       end
 
       def clone_branch_protections
-        options = @client.branch_protection(@repo.name, @repo.old_branch)
+        begin
+          repo = @client.repo(@repo.name)
+          options = @client.branch_protection(@repo.name, @repo.old_branch)
+        rescue Octokit::Forbidden
+          return
+        end
 
         if options && yes?("Would you like to clone branch protections from '#{@repo.old_branch}'?")
           updates =  BranchProtectionParams.build(options.to_h)
@@ -123,7 +147,7 @@ module MasterToMain
       end
 
       def rebase_pull_requests
-        if yes?("Would you like to rebase all requests based on #{@repo.old_branch} to #{@repo.new_branch}?")
+        if yes?("Would you like to rebase all pull requests based on #{@repo.old_branch} to #{@repo.new_branch}?")
           prs = @client.pull_requests(@repo.name)
           prs.each do |pr|
             if pr[:base][:ref] == @repo.old_branch
@@ -141,6 +165,7 @@ module MasterToMain
 
       def change_origin
         if yes?("Would you like to change origin to point to #{@repo.new_branch}?")
+          `git fetch`
           `git checkout #{@repo.new_branch}`
           `git push -u origin #{@repo.new_branch}`
         else
@@ -155,6 +180,36 @@ module MasterToMain
         say "In order to ensure no builds or deployments break, please delete your remote #{@repo.old_branch} on github", :green
         say "----------------"
       end
+
+      def ask_update_docs
+        say("We can update #{@repo.github} references in '.md' files that include master in your repo")
+        say("For example: https://#{@repo.github}/#{@repo.name}/(tree|blob)/master")
+        if yes?("Would you like to update these references?")
+          _update_docs
+          say("You should consider searching for other references not in markdown files.")
+          say("We don't want to automatically change those in case something breaks.")
+          say("But you can use `master_to_main find_references` to show you where they are")
+        end
+      end
+
+      def ask_find_references
+        _find_references if yes?("Would you like to display other URL references?")
+      end
+
+      def _update_docs
+        say "This will update all references of #{@repo.old_branch} to #{@repo.new_branch} in the following lines in this repo:"
+        say "https://#{@repo.github}/#{@repo.name}/<tree|blob>/#{@repo.old_branch}"
+        Dir.glob("**/*.md").each do |path|
+          next if path.start_with?("vendor/")
+          path = File.expand_path(path, Dir.pwd)
+          gsub_file path, /#{@repo.old_branch_regex}/, @repo.new_branch_replacement, verbose: false
+        end
+      end
+
+      def _find_references
+        say "Here are the references to urls with #{@repo.old_branch}:\n\n"
+        puts `git grep -E '#{@repo.old_branch_regex}'`
+      end
     end
   end
 end

data/lib/master_to_main/repo.rb

@@ -18,12 +18,20 @@ module MasterToMain
       "#{user}/#{repo_name}"
     end
 
-    def old_branch_url
-      "https://#{github}/tree/#{old_branch}"
+    def old_branch_regex
+      "(http[s]?:\/\/#{github}\/#{user}\/#{repo_name}\)/(tree|blob)\/#{old_branch}"
+    end
+
+    def new_branch_replacement
+      "\\1/\\2/#{new_branch}"
     end
 
     def new_branch_url
-      "https://#{github}/tree/#{new_branch}"
+      "https://#{github}/#{name}/tree/#{new_branch}"
+    end
+
+    def public_github?
+      @github == "github.com"
     end
   end
 end

data/lib/master_to_main/version.rb

@@ -1,3 +1,3 @@
 module MasterToMain
-  VERSION = "0.0.2"
+  VERSION = "0.0.7"
 end

data/master_to_main.gemspec

@@ -35,8 +35,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 
   spec.add_dependency "thor", "~> 1.0.1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: master_to_main
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.7
 platform: ruby
 authors:
 - John DeWyze
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-17 00:00:00.000000000 Z
+date: 2020-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -92,6 +92,7 @@ files:
 - ".rspec"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTORS.md
 - Gemfile
 - Gemfile.lock
 - LICENSE