github_workflow 0.4.0 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e9f6a6dfe205f986f1d69b2a778ca8aaf008833423cbde6e664818d90c7c0e0
-  data.tar.gz: 1f3dce21f39ca0e0ca4cba5ddcafa0c1817b2e0fd4d8e5ef2de82b6abd4a6f21
+  metadata.gz: 221999fe5304093bf6533718d5866ad58dc006af43945177f65e65d058dc6c8c
+  data.tar.gz: f48cea6b9a3a7588cc47f70ff257e54c4316edda6394df12cb3c25dfedb2f6de
 SHA512:
-  metadata.gz: a4b8055a935171f2c1a9e694ada8ca0b78704e4c49f5880745f4c1920023841fcd94d1819a39bdd26bee89b35a1a6c508de49f16538b45bd261dad39b0798d97
-  data.tar.gz: 824bc8e9cfadf38d68a9e6b34d22a715eeaa08c3dc260ce7637aef8e10f7cc89bfa2313992dd8a0619f88c4908207c68268c04551d3867e48c6de354ea0892e4
+  metadata.gz: 238cf09eaabe2ed9d28cd57d187f88a470a1e4614e188eb6ee709b16521848be294944c12f1571961baef940f3929e9a13bdeea0ee46c4ebff0cdd36ce4b3646
+  data.tar.gz: ea20ea5e64ff0432454c18d206bcffa3b448dd32c56e708e979de4a090875099c6737059fd9a5b8e1ad9a87482dc88a53786f2b4c76b6f593a16a54d834bb31a

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+.DS_Store

data/.ruby-version

@@ -1 +1 @@
-2.7.4
+3.1.3

data/README.md

@@ -1,26 +1,42 @@
 # Setup
 
-Install the [GitHub cli](https://cli.github.com/manual/)
+## GitHub CLI
 
+Install instructions:
+
+### MacOS:
 `brew install gh`
 
-login to the cli
+### Ubuntu
+
+1. Add a reference to the package repository
+  * `sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-key C99B11DEB97541F0`
+  * `sudo apt-add-repository https://cli.github.com/packages`
+2. Install the Github CLI
+  * `sudo apt update`
+  * `sudo apt install gh`
+
+## Heroku CLI
 
-`gh login`
+For some commands you may need the [heroku cli installed](https://devcenter.heroku.com/articles/heroku-cli#install-the-heroku-cli)
 
-# Github Workflow
+# Commands
 
 ```
 $ bin/github_workflow -h
 
 Commands:
-  github_workflow create_and_start -m, --name=NAME  # Create and start issue
-  github_workflow create_pr                         # Convert Issue to Pull Request
-  github_workflow help [COMMAND]                    # Describe available commands or one specific command
-  github_workflow info                              # Print out issue description
-  github_workflow open                              # Open issue or PR in browser
-  github_workflow push_and_pr                       # Push branch to origin and convert Issue to Pull Request
-  github_workflow start -i, --issue-id=ISSUE_ID     # Create branch named with issue number and issue title
-  github_workflow status                            # Check PR CI status
-  github_workflow reviews                           # Print out reviewers list and their PRs count
+  github_workflow cleanup                                       # Remove merged PR branches
+  github_workflow create_and_start -m, --name=NAME              # Create and start issue
+  github_workflow create_pr                                     # Convert Issue to Pull Request
+  github_workflow deploy_diff                                   # view deployment diff between staging and production for apps
+  github_workflow deploy_notes -r, --commit-range=COMMIT_RANGE  # Generate Deploy notes for a range of commits
+  github_workflow help [COMMAND]                                # Describe available commands or one specific command
+  github_workflow info                                          # Print out issue description
+  github_workflow issues                                        # Show issue information for the organization
+  github_workflow open                                          # Open issue or PR in browser
+  github_workflow push_and_pr                                   # Push branch to origin and convert Issue to Pull Request
+  github_workflow reviews                                       # Displays count of requested reviews for each user
+  github_workflow start -i, --issue-id=ISSUE_ID                 # Create branch named with issue number and issue title
+  github_workflow status                                        # Check PR CI status
 ```

data/lib/github_workflow/cli.rb

@@ -5,10 +5,12 @@ require "open3"
 require "json"
 require "terminal-table"
 require_relative "gh_cli_client.rb"
+require_relative "daisybill.rb"
 
 module GithubWorkflow
   class Cli < Thor
     PROCEED_TEXT = "Proceed? [y,yes]: ".freeze
+    TRUNCATE_DEFAULT = 50
 
     include Thor::Actions
 
@@ -16,15 +18,18 @@ module GithubWorkflow
 
     desc "start", "Create branch named with issue number and issue title"
     method_option :issue_id, aliases: "-i", type: :string, required: true
+    method_option :truncate_branch_at, aliases: "-t", type: :numeric, default: TRUNCATE_DEFAULT
+    method_option :no_checkout, type: :boolean, required: false, default: false
     def start
       stash
       rebase_main
-      create_branch
+      create_branch(options[:no_checkout])
       stash_pop
     end
 
     desc "create_pr", "Convert Issue to Pull Request"
     method_option :base_branch, aliases: "-b", type: :string
+    method_option :draft, aliases: "-d", type: :boolean, required: false, default: true
     def create_pr
       ensure_origin_exists
       convert_issue_to_pr
@@ -32,6 +37,7 @@ module GithubWorkflow
 
     desc "push_and_pr", "Push branch to origin and convert Issue to Pull Request"
     method_option :base_branch, aliases: "-b", type: :string
+    method_option :draft, aliases: "-d", type: :boolean, required: false, default: true
     def push_and_pr
       push_and_set_upstream
       convert_issue_to_pr
@@ -75,6 +81,8 @@ module GithubWorkflow
 
     desc "create_and_start", "Create and start issue"
     method_option :name, aliases: "-m", type: :string, required: true
+    method_option :truncate_branch_at, aliases: "-t", type: :numeric, default: TRUNCATE_DEFAULT
+    method_option :no_checkout, type: :boolean, required: false, default: false
     def create_and_start
       create_issue
     end
@@ -118,10 +126,44 @@ module GithubWorkflow
       end
     end
 
+    desc "deploy_diff", "view deployment diff between staging and production for apps"
+    method_option :all, aliases: "-a", type: :boolean, default: false
+    def deploy_diff
+      apps = Daisybill::APPS
+      unless options[:all]
+        current_repo = github_client.get_repo_info
+        apps.reject! do |a|
+          a[:github_org] != current_repo[:owner] || a[:github_repo] != current_repo[:repo]
+        end
+      end
+
+      apps.each do |app|
+        owner = app[:github_org]
+        repo = app[:github_repo]
+
+        puts "\n**** #{owner}/#{repo} ****\n"
+
+        full_diff = `heroku pipelines:diff -a #{app[:heroku_staging_app]}`
+        puts full_diff
+        revisions = full_diff.split("compare/").last.strip.split("...")
+
+        latest_commit = github_client.latest_remote_commit(owner: owner, repo: repo)
+
+        next if revisions.size < 2
+
+        if latest_commit != revisions.last
+          puts "WARNING - heroku staging app deploy is behind at commit #{revisions.last}. The repository is at commit #{latest_commit}"
+        end
+
+        puts formatted_deploy_notes(revisions.join('...'), owner: owner, repo: repo)
+      end
+    end
+
     desc "deploy_notes", "Generate Deploy notes for a range of commits"
     method_option :commit_range, aliases: "-r", type: :string, required: true
 
     def deploy_notes
+      puts formatted_deploy_notes(options[:commit_range], owner: github_client.get_repo_info[:owner], repo: github_client.get_repo_info[:repo])
       puts formatted_deploy_notes
     end
 
@@ -130,8 +172,13 @@ module GithubWorkflow
         `/usr/bin/open -a "/Applications/Google Chrome.app" '#{url}'`
       end
 
-      def create_branch
-        `git checkout -b #{branch_name_for_issue_number} main`
+      def create_branch(no_checkout = false)
+        if no_checkout
+          `git branch #{branch_name_for_issue_number} main`
+        else
+          `git checkout -b #{branch_name_for_issue_number} main`
+        end
+        say_info("created branch #{branch_name_for_issue_number}")
       end
 
       def ensure_origin_exists
@@ -170,6 +217,7 @@ module GithubWorkflow
           issue_number_from_branch.to_i,
           head: current_branch,
           base: options[:base_branch] || "main",
+          draft: options[:draft],
         ).tap do |response|
           if response["url"]
             pass("Issue converted to Pull Request")
@@ -195,7 +243,13 @@ module GithubWorkflow
 
       def branch_name_for_issue_number
         issue = github_client.get_issue(issue_id)
-        "#{issue['number']}_#{issue['title'].strip.downcase.gsub(/[^a-zA-Z0-9]/, '_').squeeze("_")}"
+        branch_name ="#{issue['number']}_#{issue['title'].strip.downcase.gsub(/[^a-zA-Z0-9]/, '_').squeeze("_")}"
+
+        if options[:truncate_branch_at]
+          branch_name[0...options[:truncate_branch_at]]
+        else
+          branch_name
+        end
       end
 
       def github_client
@@ -245,35 +299,37 @@ module GithubWorkflow
         `git branch`.gsub(" ", "").split("\n").select { |br| br.match /^[0-9]/ }
       end
 
-      def commits_for_range
-        github_client.commits_for_range(options[:commit_range])
-      end
-
-      def pull_request_in_commit_range
-        pr_ids = commits_for_range["commits"].map do |commit|
+      def pull_request_in_commit_range(commits, owner:, repo:)
+        pr_ids = commits.map do |commit|
           commit.dig("commit", "message").to_s.match(/(?<=\[#)\d{4,5}(?=\])/).to_s.to_i
         end.uniq.compact
 
         prs = pr_ids.map do |id|
           say_info("Fetching Pull Request ##{id}")
-          pr = github_client.get_pr(id)
+          pr = github_client.get_pr(id, owner: owner, repo: repo)
 
           next pr if pr["number"]
 
-          github_client.get_issue(id)
+          github_client.get_issue(id, owner: owner, repo: repo)
         end
       end
 
-      def formatted_deploy_notes
-        pull_request_in_commit_range.map do |pr|
-          deploy_note = pr["body"].to_s.split("**Deploy Note:**")[1].to_s.split(/\n/)[0].to_s
+      def formatted_deploy_notes(commit_range, owner:, repo:)
+        notes = pull_request_in_commit_range(
+          github_client.commits_for_range(commit_range, owner: owner, repo: repo)["commits"],
+          owner: owner,
+          repo: repo
+        ).map do |pr|
+          deploy_note = pr["body"].to_s.split("**Deploy Note:**")[1].to_s.split(/\n/)[0].to_s.strip
 
-          if deploy_note.length > 0
-            "- #{deploy_note}"
-          else
-            %Q{Missing deploy note: #{pr["title"]}}
+          if deploy_note.length > 3
+            "- [##{pr["number"]}] #{deploy_note}"
           end
-        end.unshift("[DaisyBill]")
+        end.compact
+
+        notes = ['- No notes'] if notes.empty?
+
+        notes.unshift("[#{repo}]")
       end
 
       def success?(command)

data/lib/github_workflow/daisybill.rb

@@ -0,0 +1,34 @@
+module Daisybill
+  APPS = [
+    DAISYBILL = {
+      "github_org": "daisybill",
+      "github_repo": "daisyBill",
+      "heroku_staging_app": "daisybill-staging"
+    },
+    ELLIS = {
+      "github_org": "daisybill",
+      "github_repo": "ellis",
+      "heroku_staging_app": "ellis-staging"
+    },
+    AUTH_INBOX = {
+      "github_org": "daisybill",
+      "github_repo": "auth-inbox",
+      "heroku_staging_app": "auth-inbox-staging"
+    },
+    KNOWLEDGEABLE = {
+      "github_org": "daisybill",
+      "github_repo": "knowledgeable",
+      "heroku_staging_app": "knowledgeable-staging"
+    },
+    FEE_SCHEDULE = {
+      "github_org": "daisybill",
+      "github_repo": "fee_schedule",
+      "heroku_staging_app": "fee-schedule-staging"
+    },
+    WCB_XML_CLEARINGHOUSE = {
+      "github_org": "daisybill",
+      "github_repo": "wcb_xml_clearinghouse",
+      "heroku_staging_app": "wcb-xml-clearinghouse-staging"
+    }
+  ]
+end

data/lib/github_workflow/gh_cli_client.rb

@@ -1,37 +1,56 @@
 
 class GhCliClient
 
-  def get_issue(id) 
-    request("'repos/{owner}/{repo}/issues/#{id}'")
+  def get_issue(id, owner: nil, repo: nil)
+    request("'#{path_base(owner, repo)}/issues/#{id}'")
   end
 
-  def get_pr(id) 
-    request("'repos/{owner}/{repo}/pulls/#{id}'")
+  def get_pr(id, owner: nil, repo: nil)
+    request("'#{path_base(owner, repo)}/pulls/#{id}'")
   end
 
-  def get_prs_list
-    request("'repos/{owner}/{repo}/pulls?per_page=100'")
+  def get_prs_list(owner: nil, repo: nil)
+    request("'#{path_base(owner, repo)}/pulls?per_page=100'")
   end
 
-  def create_issue(title:, body: '')
-    request("'repos/{owner}/{repo}/issues'", args: {title: title, body: body})
+  def create_issue(title:, body: '', owner: nil, repo: nil)
+    request("'#{path_base(owner, repo)}/issues'", args: {title: title, body: body})
   end
 
-  def convert_issue_to_pr(id, head:, base:)
-    request("'repos/{owner}/{repo}/pulls'", args: {issue: id.to_i, head: head, base: base})
+  def convert_issue_to_pr(id, head:, base:, owner: nil, repo: nil, draft: true)
+    request("'#{path_base(owner, repo)}/pulls'", args: {issue: id.to_i, head: head, base: base, draft: draft})
   end
 
-  def commits_for_range(commit_range)
+  def commits_for_range(commit_range, owner: nil, repo: nil)
     # https://docs.github.com/en/rest/commits/commits#compare-two-commits
-    request("'repos/{owner}/{repo}/compare/#{commit_range}'")
+    request("'#{path_base(owner, repo)}/compare/#{commit_range}'")
   end
 
-  def get_statuses(branch: '{branch}')
-    request("'repos/{owner}/{repo}/statuses/#{branch}'")
+  def get_statuses(branch: '{branch}', owner: nil, repo: nil)
+    request("'#{path_base(owner, repo)}/statuses/#{branch}'")
+  end
+
+  def get_repo_info
+    @repo_info ||= begin
+      result = `gh repo view --json owner,name -q ".owner.login,.name"`.split("\n").compact
+      {
+        owner: result[0],
+        repo: result[1]
+      }
+    end
+  end
+
+  def latest_remote_commit(owner:, repo:)
+    result = `gh browse -R '#{owner}/#{repo}' -n -c`
+    result.split("/").last.strip
   end
 
   protected
 
+  def path_base(owner, repo)
+    "repos/#{owner || "{owner}"}/#{repo || "{repo}"}"
+  end
+
   def request(url, args: {})
     arg_params = args.map{ |k,v| "-F '#{k}'='#{v}'" }.join(' ')
     response = `gh api #{url} #{arg_params}`

data/lib/github_workflow/version.rb

@@ -1,3 +1,3 @@
 module GithubWorkflow
-  VERSION = "0.4.0"
+  VERSION = "0.4.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_workflow
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.3
 platform: ruby
 authors:
 - Ben Liscio
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-24 00:00:00.000000000 Z
+date: 2023-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -96,6 +96,7 @@ files:
 - bin/github_workflow
 - github_workflow.gemspec
 - lib/github_workflow/cli.rb
+- lib/github_workflow/daisybill.rb
 - lib/github_workflow/gh_cli_client.rb
 - lib/github_workflow/version.rb
 homepage: https://github.com/daisybill/github_workflow
@@ -117,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: DaisyBill's internal github workflows