sashimi_tanpopo 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 263eb474146609f7c441ccb77681664ad19846e6aac8d7585fc7a583a08167a1
-  data.tar.gz: ddc2b35d0e3e8db88b6ff954c815446bf4c71539ca29f246c3c026ddb10b7b48
+  metadata.gz: d1e88131c30bb63dca71cc98bcec3900ab0288e503ce90097335c34789263552
+  data.tar.gz: e7daeebcc079716289560e8cf82ee551c992d1bd15feda824dee74af915bc316
 SHA512:
-  metadata.gz: 96ef60917e18568424cfe95f741223bcc7a84c66878751d57b2838b1201ee55c53e1e1102c541d3f6864bfe1a14555ce4ca0e8f67938a51981c86298088eaf5b
-  data.tar.gz: 8953c7816ff996d4bd32d30cecdcbdce5506102afff9a0284242631d1d23786c1d39e0f60875658c4031c03c4f17f9e169beecde1d1c72d40d9fd58077d88dc5
+  metadata.gz: 8d16cfb0656499041cb3364d990378b86151d9bcb7f613c8c109913e27c9e5c3b19c5e815a126c2090f132d6138845bade0c25ba1e42431cb2292ac6d5212ce2
+  data.tar.gz: 28d6a9a83e060325e5111d34ea8031d424a54d280dbe57f52f83e43af86decb4055ebc449b55d852ba7dcd591c65a848107c2a2a2a06fd8eb8327ac62057575d

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 ## [Unreleased]
 [full changelog](http://github.com/sue445/sashimi_tanpopo/compare/v0.1.3...main)
 
+## [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/53
+
 ## [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.1.3
 
 WORKDIR /work
 

data/README.md

@@ -38,10 +38,18 @@ $ 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
+```
+
 ## Usage
 ### sashimi_tanpopo local
 Change local files using recipe files
@@ -87,7 +95,7 @@ Options:
       --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,6 +103,14 @@ 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
 
@@ -121,7 +137,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 +147,18 @@ 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
+https://github.com/marketplace/actions/sashimi_tanpopo_action
+
 ## 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/lib/sashimi_tanpopo/cli.rb

@@ -44,7 +44,7 @@ module SashimiTanpopo
     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_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: []
@@ -53,7 +53,6 @@ module SashimiTanpopo
       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")
 
       Provider::GitHub.new(
         recipe_paths:     recipe_files,
@@ -70,7 +69,7 @@ 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],
@@ -89,7 +88,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 +98,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 +114,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/provider/github.rb

@@ -22,7 +22,7 @@ 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>]
@@ -51,22 +51,11 @@ 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
 
         @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
@@ -110,6 +99,21 @@ module SashimiTanpopo
 
       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 +121,14 @@ 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
+
       # Whether exists branch on repository
       #
       # @param branch [String]
@@ -140,7 +152,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 +169,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 +199,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.2.0"
 end

data/sig/sashimi_tanpopo/provider/github.rbs

@@ -17,6 +17,7 @@ module SashimiTanpopo
       @pr_labels: Array[String]
       @client: Octokit::Client
       @is_draft_pr: bool
+      @api_endpoint: String
 
       def initialize: (
           recipe_paths: Array[String],
@@ -33,7 +34,7 @@ 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],
@@ -46,8 +47,16 @@ module SashimiTanpopo
 
       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 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.2.0
 platform: ruby
 authors:
 - sue445