master_to_main 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fb2f41e4ae9e2f7ea6020cd1c6611aef54bea9a48c183007677a690accb06ae
-  data.tar.gz: cfc7140a1df1464f8f95f76ea21f015e8c7586a5bd669d50df73462ed1c1a434
+  metadata.gz: 56d7234fe688a9cb73ee0f4bf9de42557a08cd624fb55ebcc58d7d7dce01ad39
+  data.tar.gz: bb95dc6da0715587d1e4b261264af6622ecdf033d4d2060575367c4d43703422
 SHA512:
-  metadata.gz: 0274dd4547324aeb997b5b3fd2d4ebbfbb36c04709b5577ae37a6523584b472f479ec9a7773a4413caa97d0163f4c4b963fe1f36c70174b5ae140286f4d8f597
-  data.tar.gz: 4d933a38ef6fbbf26b4ed8977f3dbc61f9b05641d6debe0d47d3710c1ebeedcababc00a09d1161f813726a18135b2442bdc1f54328c50e51224fabbdf00a959b
+  metadata.gz: 3249fc202c04c40b2cc42bca971c7361af721888274422da55a79f9bef4d2732573609cea26c7e102a138464320c18fd8f806324585801bc7f503f2e533c219a
+  data.tar.gz: 44b8bb73c65c95b8e3d6bcf51e869f08a9d9596721753d64ef0f2e56b5b88eaa0f4a9dd8f2731c25b32c786dd119e8ec4dd0c1980f44b015468671f5039d0762

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 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"

data/README.md

@@ -4,29 +4,40 @@
 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 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).
 
 ## Functionality
 
-`MasterToMain` has 2 actions for now:
+`MasterToMain` has 1 actions for now:
 
-1. `github`
-2. `update_local`
+1. `update`
+1. `update_local`
+1. `update_docs`
 
-## 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 +51,9 @@ 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))
 
-## Update Local Clone
+## `update_local`
 
 ### Usage
 
@@ -63,6 +75,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`
+
+### Usage
+
+```
+master_to_main update_docs
+```
+
+This will attempt to update all references to commits on the master branch with
+commits on the main branch.
 
 ## Installation
 
@@ -86,7 +108,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,13 @@ module MasterToMain
       rebase_pull_requests
       change_origin
       delete_local_old_branch
+      ask_update_docs
+    end
+
+    desc "update_docs", "update local docs to use master"
+    def update_docs
+      prompt_info
+      gsub_docs
     end
 
     desc "update_local", "point local clone to new branch"
@@ -32,6 +40,7 @@ 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
@@ -158,6 +167,20 @@ 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
+        if yes?("Would you like to update commit and branch references in your repo?")
+          gsub_docs
+        end
+      end
+
+      def gsub_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(File.expand_path("**/*.md", Dir.pwd)).each do |path|
+          gsub_file path, @repo.old_branch_regex, @repo.new_branch_replacement, verbose: false
+        end
+      end
     end
   end
 end

data/lib/master_to_main/repo.rb

@@ -18,12 +18,16 @@ module MasterToMain
       "#{user}/#{repo_name}"
     end
 
-    def old_branch_url
-      "https://#{github}/tree/#{old_branch}"
+    def old_branch_regex
+      /https:\/\/#{github}\/#{user}\/#{repo_name}\/(tree|blob)\/#{old_branch}/
+    end
+
+    def new_branch_replacement
+      "https://#{github}/#{user}/#{repo_name}/\\1/#{new_branch}"
     end
 
     def new_branch_url
-      "https://#{github}/tree/#{new_branch}"
+      "https://#{github}/#{name}/tree/#{new_branch}"
     end
   end
 end

data/lib/master_to_main/version.rb

@@ -1,3 +1,3 @@
 module MasterToMain
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: master_to_main
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - John DeWyze
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-17 00:00:00.000000000 Z
+date: 2020-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler