Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add :git_graph_type to backmerge action #596

Draft
wants to merge 2 commits into
base: mokagio/mermaid-backmerge
Choose a base branch
from
Draft

Add :git_graph_type to backmerge action #596

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4a248d9
Add a `:git_graph_type` parameter to the backmerge PR action
mokagio Sep 25, 2024
f8dcf1b
Disable Metrics/ParameterLists for `create_backmerge_pr` method
iangmaia Oct 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 35 additions & 10 deletions ...e/plugin/wpmreleasetoolkit/actions/common/create_release_backmerge_pull_request_action.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ module Actions
class CreateReleaseBackmergePullRequestAction < Action
DEFAULT_BRANCH = 'trunk'.freeze

GIT_GRAPH_TYPES = %i[mermaid ascii both none].freeze
GIT_GRAPH_TYPES_STRING = GIT_GRAPH_TYPES.map { |t| ":#{t}" }.join(', ').freeze

def self.run(params)
token = params[:github_token]
repository = params[:repository]
Expand Down Expand Up @@ -48,7 +51,8 @@ def self.run(params)
milestone: target_milestone&.number,
reviewers: reviewers,
team_reviewers: team_reviewers,
intermediate_branch_created_callback: intermediate_branch_created_callback
intermediate_branch_created_callback: intermediate_branch_created_callback,
git_graph_type: params[:git_graph_type]
)
end.compact
end
Expand Down Expand Up @@ -88,7 +92,7 @@ def self.determine_target_branches(source_release_version:, default_branch:)
#
# @return [String] The URL of the created Pull Request, or `nil` if no PR was created.
#
def self.create_backmerge_pr(token:, repository:, title:, head_branch:, base_branch:, labels:, milestone:, reviewers:, team_reviewers:, intermediate_branch_created_callback:)
def self.create_backmerge_pr(token:, repository:, title:, head_branch:, base_branch:, labels:, milestone:, reviewers:, team_reviewers:, intermediate_branch_created_callback:, git_graph_type:) # rubocop:disable Metrics/ParameterLists
intermediate_branch = "merge/#{head_branch.gsub('/', '-')}-into-#{base_branch.gsub('/', '-')}"

if Fastlane::Helper::GitHelper.branch_exists_on_remote?(branch_name: intermediate_branch)
Expand Down Expand Up @@ -149,19 +153,32 @@ def self.create_backmerge_pr(token:, repository:, title:, head_branch:, base_bra
```
GRAPH

git_graph = case git_graph_type
when :both
<<~GRAPH
#{meramid_git_graph}

<details>
<summary>Expand to see an ASCII representation of the Git graph above</summary>

#{ascii_git_graph}
GRAPH
when :mermaid
meramid_git_graph
when :ascii
ascii_git_graph
when :none
''
else
UI.user_error!("Unsupported Git graph type '#{params[:git_graph_type]}'")
end

pr_body = <<~BODY
Merging `#{head_branch}` into `#{base_branch}`.

Via intermediate branch `#{intermediate_branch}`, to help fix conflicts if any:

#{meramid_git_graph}

<details>
<summary>Expand to see an ASCII representation of the Git graph above</summary>

#{ascii_git_graph}

</details>
#{git_graph}
BODY

other_action.create_pull_request(
Expand Down Expand Up @@ -244,6 +261,14 @@ def self.available_options
description: 'Callback to allow for the caller to perform operations on the intermediate branch before pushing. The call back receives two parameters: the base (target) branch for the PR and the intermediate branch name',
optional: true,
type: Proc),
FastlaneCore::ConfigItem.new(key: :git_graph_type,
description: "The type of Git graph to show. Possible values: #{GIT_GRAPH_TYPES_STRING}",
optional: true,
type: Symbol,
default_value: :both,
verify_block: proc do |value|
UI.user_error!("Unsupported Git graph type '#{value}'. Supported values are: #{GIT_GRAPH_TYPES_STRING}.") unless GIT_GRAPH_TYPES.include?(value)
end),
Fastlane::Helper::GithubHelper.github_token_config_item,
]
end
Expand Down