sashimi_tanpopo 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 263eb474146609f7c441ccb77681664ad19846e6aac8d7585fc7a583a08167a1
-  data.tar.gz: ddc2b35d0e3e8db88b6ff954c815446bf4c71539ca29f246c3c026ddb10b7b48
+  metadata.gz: 4cb5f08e4ea1b3f4a7dea92a3fc242ce77894fe0d6d610a48aab10e5b4bc3f99
+  data.tar.gz: ef6c01d72528207f0cad5961f894efbc38b885fdd0b425166245ac3c89c8fda4
 SHA512:
-  metadata.gz: 96ef60917e18568424cfe95f741223bcc7a84c66878751d57b2838b1201ee55c53e1e1102c541d3f6864bfe1a14555ce4ca0e8f67938a51981c86298088eaf5b
-  data.tar.gz: 8953c7816ff996d4bd32d30cecdcbdce5506102afff9a0284242631d1d23786c1d39e0f60875658c4031c03c4f17f9e169beecde1d1c72d40d9fd58077d88dc5
+  metadata.gz: 99ea3fc4cd53589883c574b56052a2c0147a5f238b698e748edd07330209cbcb84a49aeafbe7930ff9e29bb66f3859428eea9fffea2e719ddb283d7a7f96759b
+  data.tar.gz: 259c452fbeb224fa6b2c8a150429c028c6fff5f3d7c45659166d5de4a69ec9b6c058025be147fd75175f0d837b44bc86fc3a47f2dab5a5344be10de4710780e0

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
-[full changelog](http://github.com/sue445/sashimi_tanpopo/compare/v0.1.3...main)
+[full changelog](http://github.com/sue445/sashimi_tanpopo/compare/v0.3.0...main)
+
+## [0.3.0](https://github.com/sue445/sashimi_tanpopo/releases/tag/v0.3.0) - 2025-10-30
+[full changelog](http://github.com/sue445/sashimi_tanpopo/compare/v0.2.0...v0.3.0)
+
+* Support GitHub Actions Job Summary
+  * https://github.com/sue445/sashimi_tanpopo/pull/62
+
+## [0.2.0](https://github.com/sue445/sashimi_tanpopo/releases/tag/v0.2.0) - 2025-10-22
+[full changelog](http://github.com/sue445/sashimi_tanpopo/compare/v0.1.3...v0.2.0)
+
+* Change `--pr-target-branch` and `--mr-target-branch` 's default value to repository's default branch
+    * https://github.com/sue445/sashimi_tanpopo/pull/52
 
 ## [0.1.3](https://github.com/sue445/sashimi_tanpopo/releases/tag/v0.1.3) - 2025-10-19
 [full changelog](http://github.com/sue445/sashimi_tanpopo/compare/v0.1.2...v0.1.3)

data/Dockerfile

@@ -1,7 +1,7 @@
 ARG RUBY_VERSION=3.4
 FROM ruby:${RUBY_VERSION}-alpine
 
-ARG SASHIMI_TANPOPO_VERSION=0.1.2
+ARG SASHIMI_TANPOPO_VERSION=0.2.0
 
 WORKDIR /work
 

data/README.md

@@ -38,10 +38,20 @@ $ sashimi_tanpopo github --target-dir=/path/to/app --params=ruby_version:3.4.5 \
 ```
 
 ## Installation
+### Use gem directly
 ```bash
 gem install sashimi_tanpopo
 ```
 
+### Use via docker
+e.g.
+
+```bash
+docker run -v /path/to/recipe_dir:/recipes:ro -v $(pwd):/work --rm ghcr.io/sue445/sashimi_tanpopo <local|github|gitlab> <arguments> /recipes/recipe.rb
+```
+
+c.f. https://github.com/sue445/sashimi_tanpopo/pkgs/container/sashimi_tanpopo
+
 ## Usage
 ### sashimi_tanpopo local
 Change local files using recipe files
@@ -62,7 +72,7 @@ Options:
 ```
 
 ### sashimi_tanpopo github
-Change local files using recipe files and create Pull Request
+Change local files using recipe files and create Pull Request on GitHub
 
 ```bash
 $ sashimi_tanpopo help github
@@ -84,10 +94,11 @@ Options:
       [--github-api-url=GITHUB_API_URL]                 # GitHub API endpoint. One of --github-api-url or $GITHUB_API_URL is required [$GITHUB_API_URL]
                                                         # Default: https://api.github.com
       [--github-token=GITHUB_TOKEN]                     # GitHub access token. One of --github-token or $GITHUB_TOKEN is required [$GITHUB_TOKEN]
+      [--github-step-summary=GITHUB_STEP_SUMMARY]       # Path to GitHub step summary file [$GITHUB_STEP_SUMMARY]
       --pr-title=PR_TITLE                               # Pull Request title
       [--pr-body=PR_BODY]                               # Pull Request body
       --pr-source-branch=pr_branch                      # Pull Request source branch (a.k.a. head branch)
-      [--pr-target-branch=main]                         # Pull Request target branch (a.k.a. base branch). One of --pr-target-branch or $GITHUB_REF_NAME is required [$GITHUB_REF_NAME]
+      [--pr-target-branch=main]                         # Pull Request target branch (a.k.a. base branch). Default: default branch of repository (e.g. main, master)
       [--pr-assignees=one two three]                    # Pull Request assignees
       [--pr-reviewers=one two three]                    # Pull Request reviewers
       [--pr-labels=one two three]                       # Pull Request labels
@@ -95,8 +106,18 @@ Options:
                                                         # Default: false
 ```
 
+`--github-token` requires followings repository permissions
+
+* Contents: Read and Write
+* Pull requests: Read and Write
+* Metadata: Read-only
+* Workflows: Read and Write
+  * Only if you want to change `.github/workflows/*.yml`
+
 ### sashimi_tanpopo gitlab
-Change local files using recipe files and create Merge Request
+Change local files using recipe files and create Merge Request on [GitLab™](https://about.gitlab.com/)
+
+_GITLAB is a trademark of GitLab Inc. in the United States and other countries and regions_
 
 ```bash
 $ sashimi_tanpopo help gitlab
@@ -121,7 +142,7 @@ Options:
       --mr-title=MR_TITLE                                              # Merge Request title
       [--mr-body=MR_BODY]                                              # Merge Request body
       --mr-source-branch=mr_branch                                     # Merge Request source branch
-      [--mr-target-branch=main]                                        # Merge Request target branch). One of --mr-target-branch, $MR_TARGET_BRANCH or $CI_DEFAULT_BRANCH is required [$MR_TARGET_BRANCH, $CI_DEFAULT_BRANCH]
+      [--mr-target-branch=main]                                        # Merge Request target branch. Default: default branch of project (e.g. main, master)
       [--mr-assignees=one two three]                                   # Merge Request assignees
       [--mr-reviewers=one two three]                                   # Merge Request reviewers
       [--mr-labels=one two three]                                      # Merge Request labels
@@ -131,9 +152,29 @@ Options:
                                                                        # Default: false
 ```
 
+`--gitlab-token` requires followings permissions
+
+* Role: Developer
+* Scopes: `api`
+
 ## Recipe file specification
 See [docs/RECIPE.md](docs/RECIPE.md)
 
+## Use on CI services
+### GitHub Actions
+See https://github.com/marketplace/actions/sashimi_tanpopo_action
+
+### GitLab CI
+See https://gitlab.com/explore/catalog/sue445/sashimi_tanpopo-components
+
+## Real example
+sashimi_tanpopo is used to manage configuration files for my multiple personal repositories.
+
+See followings.
+
+* https://github.com/sue445/sashimi_tanpopo-personal
+* https://gitlab.com/sue445/sashimi_tanpopo-personal-gitlab
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/docs/RECIPE.md

@@ -2,6 +2,7 @@
 Recipe file is simple Ruby script, with some exceptions.
 
 By avoiding the DSL methods listed below, you are free to write code as you like.
+(e.g. write your cool code, define variables, require other files)
 
 ## Special methods available within recipe file
 The following methods are special variables available within recipe file.

data/lib/sashimi_tanpopo/cli.rb

@@ -35,25 +35,27 @@ module SashimiTanpopo
 
     desc "github RECIPE [RECIPE...]", "Change local files using recipe files and create Pull Request"
     define_exec_common_options
-    option :git_user_name,     type: :string,  desc: "user name for git commit. Default: username of user authenticated with token"
-    option :git_email,         type: :string,  desc: "email for git commit. Default: <git_user_name>@users.noreply.<github_host>"
-    option :message,           type: :string,  desc: "commit message", required: true, aliases: "-m", banner: "COMMIT_MESSAGE"
-    option :github_repository, type: :string,  desc: "GitHub repository for Pull Request. One of --github--repository or $GITHUB_REPOSITORY is required [$GITHUB_REPOSITORY]", banner: "user/repo"
-    option :github_api_url,    type: :string,  desc: "GitHub API endpoint. One of --github-api-url or $GITHUB_API_URL is required [$GITHUB_API_URL]", default: "https://api.github.com"
-    option :github_token,      type: :string,  desc: "GitHub access token. One of --github-token or $GITHUB_TOKEN is required [$GITHUB_TOKEN]"
-    option :pr_title,          type: :string,  desc: "Pull Request title", required: true
-    option :pr_body,           type: :string,  desc: "Pull Request body"
-    option :pr_source_branch,  type: :string,  desc: "Pull Request source branch (a.k.a. head branch)", required: true, banner: "pr_branch"
-    option :pr_target_branch,  type: :string,  desc: "Pull Request target branch (a.k.a. base branch). One of --pr-target-branch or $GITHUB_REF_NAME is required [$GITHUB_REF_NAME]", banner: "main"
-    option :pr_assignees,      type: :array,   desc: "Pull Request assignees", default: []
-    option :pr_reviewers,      type: :array,   desc: "Pull Request reviewers", default: []
-    option :pr_labels,         type: :array,   desc: "Pull Request labels", default: []
-    option :pr_draft,          type: :boolean, desc: "Whether to create draft Pull Request", default: false
+    option :git_user_name,       type: :string,  desc: "user name for git commit. Default: username of user authenticated with token"
+    option :git_email,           type: :string,  desc: "email for git commit. Default: <git_user_name>@users.noreply.<github_host>"
+    option :message,             type: :string,  desc: "commit message", required: true, aliases: "-m", banner: "COMMIT_MESSAGE"
+    option :github_repository,   type: :string,  desc: "GitHub repository for Pull Request. One of --github--repository or $GITHUB_REPOSITORY is required [$GITHUB_REPOSITORY]", banner: "user/repo"
+    option :github_api_url,      type: :string,  desc: "GitHub API endpoint. One of --github-api-url or $GITHUB_API_URL is required [$GITHUB_API_URL]", default: "https://api.github.com"
+    option :github_token,        type: :string,  desc: "GitHub access token. One of --github-token or $GITHUB_TOKEN is required [$GITHUB_TOKEN]"
+    option :github_step_summary, type: :string,  desc: "Path to GitHub step summary file [$GITHUB_STEP_SUMMARY]"
+    option :pr_title,            type: :string,  desc: "Pull Request title", required: true
+    option :pr_body,             type: :string,  desc: "Pull Request body"
+    option :pr_source_branch,    type: :string,  desc: "Pull Request source branch (a.k.a. head branch)", required: true, banner: "pr_branch"
+    option :pr_target_branch,    type: :string,  desc: "Pull Request target branch (a.k.a. base branch). Default: default branch of repository (e.g. main, master)", banner: "main"
+    option :pr_assignees,        type: :array,   desc: "Pull Request assignees", default: []
+    option :pr_reviewers,        type: :array,   desc: "Pull Request reviewers", default: []
+    option :pr_labels,           type: :array,   desc: "Pull Request labels", default: []
+    option :pr_draft,            type: :boolean, desc: "Whether to create draft Pull Request", default: false
     def github(*recipe_files)
       repository       = option_or_env!(option_name: :github_repository, env_name: "GITHUB_REPOSITORY")
       api_endpoint     = option_or_env!(option_name: :github_api_url,    env_name: "GITHUB_API_URL")
       access_token     = option_or_env!(option_name: :github_token,      env_name: "GITHUB_TOKEN")
-      pr_target_branch = option_or_env!(option_name: :pr_target_branch,  env_name: "GITHUB_REF_NAME")
+
+      summary_path = option_or_env(option_name: :github_step_summary, env_name: "GITHUB_STEP_SUMMARY")
 
       Provider::GitHub.new(
         recipe_paths:     recipe_files,
@@ -70,11 +72,12 @@ module SashimiTanpopo
         pr_title:         options[:pr_title],
         pr_body:          options[:pr_body],
         pr_source_branch: options[:pr_source_branch],
-        pr_target_branch: pr_target_branch,
+        pr_target_branch: options[:pr_target_branch],
         pr_assignees:     options[:pr_assignees],
         pr_reviewers:     options[:pr_reviewers],
         pr_labels:        options[:pr_labels],
         is_draft_pr:      options[:pr_draft],
+        summary_path:     summary_path,
       ).perform
     end
 
@@ -89,7 +92,7 @@ module SashimiTanpopo
     option :mr_title,          type: :string,  desc: "Merge Request title", required: true
     option :mr_body,           type: :string,  desc: "Merge Request body"
     option :mr_source_branch,  type: :string,  desc: "Merge Request source branch", required: true, banner: "mr_branch"
-    option :mr_target_branch,  type: :string,  desc: "Merge Request target branch). One of --mr-target-branch, $MR_TARGET_BRANCH or $CI_DEFAULT_BRANCH is required [$MR_TARGET_BRANCH, $CI_DEFAULT_BRANCH]", banner: "main"
+    option :mr_target_branch,  type: :string,  desc: "Merge Request target branch. Default: default branch of project (e.g. main, master)", banner: "main"
     option :mr_assignees,      type: :array,   desc: "Merge Request assignees", default: []
     option :mr_reviewers,      type: :array,   desc: "Merge Request reviewers", default: []
     option :mr_labels,         type: :array,   desc: "Merge Request labels", default: []
@@ -99,7 +102,6 @@ module SashimiTanpopo
       repository       = option_or_env!(option_name: :gitlab_project,   env_name: %w[GITLAB_PROJECT CI_PROJECT_PATH])
       api_endpoint     = option_or_env!(option_name: :gitlab_api_url,   env_name: %w[GITLAB_API_URL CI_API_V4_URL])
       access_token     = option_or_env!(option_name: :gitlab_token,     env_name: "GITLAB_TOKEN")
-      mr_target_branch = option_or_env!(option_name: :mr_target_branch, env_name: %w[MR_TARGET_BRANCH CI_DEFAULT_BRANCH])
 
       Provider::GitLab.new(
         recipe_paths:     recipe_files,
@@ -116,7 +118,7 @@ module SashimiTanpopo
         mr_title:         options[:mr_title],
         mr_body:          options[:mr_body],
         mr_source_branch: options[:mr_source_branch],
-        mr_target_branch: mr_target_branch,
+        mr_target_branch: options[:mr_target_branch],
         mr_assignees:     options[:mr_assignees],
         mr_reviewers:     options[:mr_reviewers],
         mr_labels:        options[:mr_labels],

data/lib/sashimi_tanpopo/diff_helper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SashimiTanpopo
+  module DiffHelper
+    # Generate diff between 2 strings
+    #
+    # @param str1 [String]
+    # @param str2 [String]
+    # @param is_colored [Boolean]
+    #
+    # @return [String]
+    def self.generate_diff(str1, str2, is_colored:)
+      format = is_colored ? :color : :text
+      Diffy::Diff.new(str1, str2, context: 3).to_s(format)
+    end
+  end
+end

data/lib/sashimi_tanpopo/dsl.rb

@@ -70,8 +70,7 @@ module SashimiTanpopo
         @__dry_run__ = dry_run
         @__target_dir__ = target_dir
         @__is_update_local__ = is_update_local
-
-        @__diffy_format__ = is_colored ? :color : :text
+        @__is_colored__ = is_colored
       end
 
       # passed from `--params`
@@ -177,7 +176,7 @@ module SashimiTanpopo
       # @param str1 [String]
       # @param str2 [String]
       def show_diff(str1, str2)
-        diff_text = Diffy::Diff.new(str1, str2, context: 3).to_s(@__diffy_format__) # steep:ignore
+        diff_text = DiffHelper.generate_diff(str1, str2, is_colored: @__is_colored__)
 
         SashimiTanpopo.logger.info "diff:"
 

data/lib/sashimi_tanpopo/provider/github.rb

@@ -22,16 +22,18 @@ module SashimiTanpopo
       # @param pr_title [String]
       # @param pr_body [String]
       # @param pr_source_branch [String] Pull Request source branch (a.k.a. head branch)
-      # @param pr_target_branch [String] Pull Request target branch (a.k.a. base branch)
+      # @param pr_target_branch [String,nil] Pull Request target branch (a.k.a. base branch)
       # @param pr_assignees [Array<String>]
       # @param pr_reviewers [Array<String>]
       # @param pr_labels [Array<String>]
       # @param is_draft_pr [Boolean] Whether create draft Pull Request
+      # @param summary_path [String,nil]
       def initialize(recipe_paths:, target_dir:, params:, dry_run:, is_colored:,
                      git_username:, git_email:, commit_message:,
                      repository:, access_token:, api_endpoint: DEFAULT_API_ENDPOINT,
                      pr_title:, pr_body:, pr_source_branch:, pr_target_branch:,
-                     pr_assignees: [], pr_reviewers: [], pr_labels: [], is_draft_pr:)
+                     pr_assignees: [], pr_reviewers: [], pr_labels: [], is_draft_pr:,
+                     summary_path:)
         super(
           recipe_paths:    recipe_paths,
           target_dir:      target_dir,
@@ -51,22 +53,12 @@ module SashimiTanpopo
         @pr_reviewers = pr_reviewers
         @pr_labels = pr_labels
         @is_draft_pr = is_draft_pr
+        @git_username = git_username
+        @git_email = git_email
+        @api_endpoint = api_endpoint
+        @summary_path = summary_path || ""
 
         @client = Octokit::Client.new(api_endpoint: api_endpoint, access_token: access_token)
-
-        @git_username =
-          if git_username
-            git_username
-          else
-            current_user_name
-          end
-
-        @git_email =
-          if git_email
-            git_email
-          else
-            "#{@git_username}@users.noreply.#{self.class.github_host(api_endpoint)}"
-          end
       end
 
       # Apply recipe files
@@ -76,6 +68,8 @@ module SashimiTanpopo
       def perform
         changed_files = apply_recipe_files
 
+        write_summary_file(changed_files)
+
         return nil if changed_files.empty? || @dry_run
 
         if exists_branch?(@pr_source_branch)
@@ -108,8 +102,53 @@ module SashimiTanpopo
         DEFAULT_GITHUB_HOST
       end
 
+      # @param changed_files [Hash<String, { before_content: String, after_content: String, mode: String }>] key: f path, value: Hash
+      # @param dry_run [Boolean]
+      #
+      # @return [String]
+      def self.generate_summary(changed_files:, dry_run:)
+        header = +"## :page_facing_up: sashimi_tanpopo report"
+        header << " (dry run)" if dry_run
+
+        lines = [header]
+
+        if changed_files.empty?
+          lines.push(
+            "no changes",
+            "",
+          )
+        else
+          changed_files.each do |path, data|
+            lines.push(
+              "### :memo: #{path}",
+              "```diff",
+              SashimiTanpopo::DiffHelper.generate_diff(data[:before_content], data[:after_content], is_colored: false).rstrip,
+              "```",
+              "",
+            )
+          end
+        end
+
+        lines.join("\n")
+      end
+
       private
 
+      # @return [String]
+      def pr_target_branch
+        @pr_target_branch ||= get_default_branch
+      end
+
+      # @return [String]
+      def git_username
+        @git_username ||= current_user_name
+      end
+
+      # @return [String]
+      def git_email
+        @git_email ||= "#{git_username}@users.noreply.#{self.class.github_host(@api_endpoint)}"
+      end
+
       # @return [String]
       #
       # @see https://docs.github.com/en/rest/users/users?apiVersion=2022-11-28#get-the-authenticated-user
@@ -117,6 +156,30 @@ module SashimiTanpopo
         @client.user[:login]
       end
 
+      # @return [String]
+      #
+      # @see https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#get-a-repository
+      def get_default_branch
+        res = @client.repository(@repository)
+        res[:default_branch]
+      end
+
+      # @param changed_files [Hash<String, { before_content: String, after_content: String, mode: String }>] key: f path, value: Hash
+      def write_summary_file(changed_files)
+        return if @summary_path.empty?
+
+        unless File.exist?(@summary_path)
+          SashimiTanpopo.logger.warn "#{@summary_path} does not exist"
+          return
+        end
+
+        summary = self.class.generate_summary(changed_files: changed_files, dry_run: @dry_run)
+
+        File.open(@summary_path, "a") do |f|
+          f.write(summary)
+        end
+      end
+
       # Whether exists branch on repository
       #
       # @param branch [String]
@@ -140,7 +203,7 @@ module SashimiTanpopo
       # @see https://docs.github.com/en/rest/git/commits?apiVersion=2022-11-28#create-a-commit
       # @see https://docs.github.com/en/rest/git/refs?apiVersion=2022-11-28#update-a-reference
       def create_branch_and_push_changes(changed_files)
-        current_ref = @client.ref(@repository, "heads/#{@pr_target_branch}")
+        current_ref = @client.ref(@repository, "heads/#{pr_target_branch}")
         branch_ref = @client.create_ref(@repository, "heads/#{@pr_source_branch}", current_ref.object.sha) # steep:ignore
 
         branch_commit = @client.commit(@repository, branch_ref.object.sha) # steep:ignore
@@ -157,8 +220,8 @@ module SashimiTanpopo
           tree.sha, # steep:ignore
           branch_ref.object.sha, # steep:ignore
           author: {
-            name: @git_username,
-            email: @git_email,
+            name: git_username,
+            email: git_email,
           }
         )
 
@@ -187,7 +250,7 @@ module SashimiTanpopo
       #
       # @see https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#create-a-pull-request
       def create_pull_request
-        pr = @client.create_pull_request(@repository, @pr_target_branch, @pr_source_branch, @pr_title, @pr_body, draft: @is_draft_pr)
+        pr = @client.create_pull_request(@repository, pr_target_branch, @pr_source_branch, @pr_title, @pr_body, draft: @is_draft_pr)
 
         SashimiTanpopo.logger.info "Pull Request is created: #{pr[:html_url]}"
 

data/lib/sashimi_tanpopo/provider/gitlab.rb

@@ -22,7 +22,7 @@ module SashimiTanpopo
       # @param mr_title [String]
       # @param mr_body [String]
       # @param mr_source_branch [String] Merge Request source branch
-      # @param mr_target_branch [String] Merge Request target branch
+      # @param mr_target_branch [String,nil] Merge Request target branch
       # @param mr_assignees [Array<String>]
       # @param mr_reviewers [Array<String>]
       # @param mr_labels [Array<String>]
@@ -53,22 +53,11 @@ module SashimiTanpopo
         @mr_labels = mr_labels
         @is_draft_mr = is_draft_mr
         @is_auto_merge = is_auto_merge
+        @git_username = git_username
+        @git_email = git_email
+        @api_endpoint = api_endpoint
 
         @gitlab = Gitlab.client(endpoint: api_endpoint, private_token: access_token)
-
-        @git_username =
-          if git_username
-            git_username
-          else
-            current_user_name
-          end
-
-        @git_email =
-          if git_email
-            git_email
-          else
-            "#{@git_username}@noreply.#{self.class.gitlab_host(api_endpoint)}"
-          end
       end
 
       # Apply recipe files
@@ -161,6 +150,21 @@ module SashimiTanpopo
 
       private
 
+      # @return [String]
+      def mr_target_branch
+        @mr_target_branch ||= get_default_branch
+      end
+
+      # @return [String]
+      def git_username
+        @git_username ||= current_user_name
+      end
+
+      # @return [String]
+      def git_email
+        @git_email ||= "#{git_username}@noreply.#{self.class.gitlab_host(@api_endpoint)}"
+      end
+
       def with_retry
         retry_count ||= 0 # steep:ignore
 
@@ -189,6 +193,14 @@ module SashimiTanpopo
         user["username"]
       end
 
+      # @return [String]
+      def get_default_branch
+        project = with_retry do
+          @gitlab.project(@repository)
+        end
+        project["default_branch"]
+      end
+
       # Whether exists branch on repository
       #
       # @param branch [String]
@@ -226,9 +238,9 @@ module SashimiTanpopo
             @mr_source_branch,
             @commit_message,
             actions,
-            start_branch: @mr_target_branch,
-            author_email: @git_email,
-            author_name:  @git_username,
+            start_branch: mr_target_branch,
+            author_email: git_email,
+            author_name:  git_username,
           )
         end
       end
@@ -239,7 +251,7 @@ module SashimiTanpopo
       def create_merge_request
         params = {
           source_branch:        @mr_source_branch,
-          target_branch:        @mr_target_branch,
+          target_branch:        mr_target_branch,
           remove_source_branch: true,
           description:          @mr_body,
         }

data/lib/sashimi_tanpopo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SashimiTanpopo
-  VERSION = "0.1.3"
+  VERSION = "0.3.0"
 end

data/lib/sashimi_tanpopo.rb

@@ -10,6 +10,7 @@ require_relative "sashimi_tanpopo/version"
 require_relative "sashimi_tanpopo/dsl"
 require_relative "sashimi_tanpopo/logger"
 require_relative "sashimi_tanpopo/provider"
+require_relative "sashimi_tanpopo/diff_helper"
 
 module SashimiTanpopo
   class Error < StandardError; end

data/rbs_collection.lock.yaml

@@ -6,7 +6,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    revision: 533a74999571ba71d84cbbb3ef47ba34de526a12
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: base64
@@ -14,7 +14,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    revision: 533a74999571ba71d84cbbb3ef47ba34de526a12
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: bigdecimal
@@ -22,7 +22,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    revision: 533a74999571ba71d84cbbb3ef47ba34de526a12
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: csv
@@ -30,7 +30,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    revision: 533a74999571ba71d84cbbb3ef47ba34de526a12
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: date
@@ -46,7 +46,15 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    revision: 533a74999571ba71d84cbbb3ef47ba34de526a12
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: diffy
+  version: '3.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 533a74999571ba71d84cbbb3ef47ba34de526a12
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: erb
@@ -58,7 +66,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    revision: 533a74999571ba71d84cbbb3ef47ba34de526a12
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: fileutils
@@ -69,12 +77,20 @@ gems:
   version: '0'
   source:
     type: stdlib
+- name: gitlab
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 533a74999571ba71d84cbbb3ef47ba34de526a12
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
 - name: hashdiff
   version: '1.1'
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    revision: 533a74999571ba71d84cbbb3ef47ba34de526a12
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: httparty
@@ -82,7 +98,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    revision: 533a74999571ba71d84cbbb3ef47ba34de526a12
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: io-console
@@ -102,7 +118,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    revision: 533a74999571ba71d84cbbb3ef47ba34de526a12
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: monitor
@@ -122,7 +138,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    revision: 533a74999571ba71d84cbbb3ef47ba34de526a12
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: parallel
@@ -130,7 +146,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    revision: 533a74999571ba71d84cbbb3ef47ba34de526a12
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: pp
@@ -154,7 +170,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    revision: 533a74999571ba71d84cbbb3ef47ba34de526a12
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: rdoc
@@ -170,7 +186,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    revision: 533a74999571ba71d84cbbb3ef47ba34de526a12
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: timeout
@@ -190,7 +206,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    revision: 533a74999571ba71d84cbbb3ef47ba34de526a12
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 gemfile_lock_path: Gemfile.lock

data/sig/sashimi_tanpopo/diff_helper.rbs

@@ -0,0 +1,5 @@
+module SashimiTanpopo
+  module DiffHelper
+    def self.generate_diff: (String str1, String str2, is_colored: bool) -> String
+  end
+end

data/sig/sashimi_tanpopo/dsl.rbs

@@ -24,7 +24,7 @@ module SashimiTanpopo
       @__dry_run__: bool
       @__target_dir__: String
       @__is_update_local__: bool
-      @__diffy_format__: Symbol
+      @__is_colored__: bool
       @__changed_files__: changed_files
 
       def initialize: (

data/sig/sashimi_tanpopo/provider/github.rbs

@@ -17,6 +17,8 @@ module SashimiTanpopo
       @pr_labels: Array[String]
       @client: Octokit::Client
       @is_draft_pr: bool
+      @api_endpoint: String
+      @summary_path: String
 
       def initialize: (
           recipe_paths: Array[String],
@@ -33,21 +35,34 @@ module SashimiTanpopo
           pr_title: String,
           pr_body: String,
           pr_source_branch: String,
-          pr_target_branch: String,
+          pr_target_branch: String?,
           ?pr_assignees: Array[String],
           ?pr_reviewers: Array[String],
           ?pr_labels: Array[String],
           is_draft_pr: bool,
+          summary_path: String?
         ) -> void
 
       def perform: () -> String?
 
       def self.github_host: (String api_endpoint) -> String
 
+      def self.generate_summary: (changed_files: changed_files, dry_run: bool) -> String
+
       private
 
+      def pr_target_branch: () -> String
+
+      def git_username: () -> String
+
+      def git_email: () -> String
+
       def current_user_name: () -> String
 
+      def get_default_branch: () -> String
+
+      def write_summary_file: (changed_files changed_files) -> void
+
       def exists_branch?: (String branch) -> bool
 
       def create_branch_and_push_changes: (changed_files changed_files) -> void

data/sig/sashimi_tanpopo/provider/gitlab.rbs

@@ -18,6 +18,7 @@ module SashimiTanpopo
       @gitlab: Gitlab::Client
       @is_draft_mr: bool
       @is_auto_merge: bool
+      @api_endpoint: String
 
       def initialize: (
           recipe_paths: Array[String],
@@ -34,7 +35,7 @@ module SashimiTanpopo
           mr_title: String,
           mr_body: String,
           mr_source_branch: String,
-          mr_target_branch: String,
+          mr_target_branch: String?,
           ?mr_assignees: Array[String],
           ?mr_reviewers: Array[String],
           ?mr_labels: Array[String],
@@ -56,10 +57,18 @@ module SashimiTanpopo
 
       private
 
+      def mr_target_branch: () -> String
+
+      def git_username: () -> String
+
+      def git_email: () -> String
+
       def with_retry: [T] { () -> T } -> T
 
       def current_user_name: () -> String
 
+      def get_default_branch: () -> String
+
       def exists_branch?: (String branch) -> bool
 
       def create_branch_and_push_changes: (Hash[String, { before_content: String, after_content: String, mode: String }] changed_files) -> void

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sashimi_tanpopo
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.3.0
 platform: ruby
 authors:
 - sue445
@@ -261,6 +261,7 @@ files:
 - exe/sashimi_tanpopo
 - lib/sashimi_tanpopo.rb
 - lib/sashimi_tanpopo/cli.rb
+- lib/sashimi_tanpopo/diff_helper.rb
 - lib/sashimi_tanpopo/dsl.rb
 - lib/sashimi_tanpopo/logger.rb
 - lib/sashimi_tanpopo/provider.rb
@@ -273,6 +274,7 @@ files:
 - rbs_collection.yaml
 - sig/sashimi_tanpopo.rbs
 - sig/sashimi_tanpopo/cli.rbs
+- sig/sashimi_tanpopo/diff_helper.rbs
 - sig/sashimi_tanpopo/dsl.rbs
 - sig/sashimi_tanpopo/logger.rbs
 - sig/sashimi_tanpopo/provider/base.rbs