Skip to content

New/Set-GitHubRepository: Add Support for Merge Commit Title and Message Options #385

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

Merged
HowardWolosky merged 10 commits into from
May 2, 2023
Merged

New/Set-GitHubRepository: Add Support for Merge Commit Title and Message Options #385

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e9ce758
Initial Commit
X-Guardian Jan 10, 2023
1f3663e
Merge branch 'master' into SquashMergeCommitTitle
HowardWolosky Feb 26, 2023
e06ce9d
Merge branch 'master' into SquashMergeCommitTitle
X-Guardian Feb 27, 2023
eb9839d
Update property names
X-Guardian Apr 19, 2023
c39e00b
Merge branch 'master' into SquashMergeCommitTitle
X-Guardian Apr 21, 2023
294e1bc
Merge branch 'master' into SquashMergeCommitTitle
HowardWolosky Apr 29, 2023
79be8c3
Apply suggestions from code review
X-Guardian Apr 29, 2023
608a565
Merge branch 'master' into SquashMergeCommitTitle
X-Guardian May 1, 2023
476900a
Update constants
X-Guardian May 1, 2023
6dc271e
Update GitHubRepositories.ps1
HowardWolosky May 1, 2023
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
88 changes: 88 additions & 0 deletions GitHubRepositories.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,34 @@ filter New-GitHubRepository
By default, rebase-merge pull requests will be allowed.
Specify this to disallow.

.PARAMETER SquashMergeCommitTitle
Specifies the default value for a squash merge commit title. This can be one of the
following values:
- PR_TITLE - default to the pull request's title.
- COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull
request's title (when more than one commit).

.PARAMETER SquashMergeCommitMessage
Specifies the default vaule for a squash merge commit message. This can be one of the
following values:
- PR_BODY - default to the pull request's body.
- COMMIT_MESSAGES - default to the branch's commit messages.
- BLANK - default to a blank commit message.

.PARAMETER MergeCommitTitle
Specifies the default value for a merge commit title. This can be one of the
following values:
- PR_TITLE - default to the pull request's title.
- MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request
#123 from branch-name).

.PARAMETER MergeCommitMessage
Specifies the default vaule for a merge commit message. This can be one of the
following values:
- PR_TITLE - default to the pull request's title.
- PR_BODY - default to the pull request's body.
- BLANK - default to a blank commit message.

.PARAMETER DeleteBranchOnMerge
Specifies the automatic deleting of head branches when pull requests are merged.

Expand Down Expand Up @@ -165,6 +193,18 @@ filter New-GitHubRepository

[switch] $DisallowRebaseMerge,

[ValidateSet('PR_TITLE', 'COMMIT_OR_PR_TITLE')]
Copy link
Contributor

@HowardWolosky HowardWolosky Feb 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer using PowerShell casing syntax for parameters, and then converting as necessary within the function for what the API requires. So, instead of PR_TITLE, it would be PRTitle and instead of MERGE_MESSAGE it would be MergeMessage. Similar for the other ones.

You can then use a hashtable to cleanly handle the conversions:

e.g.

$squashMergeCommitTitleConversion = @{
    'PRTitle' = 'PR_TITLE'
    'MergeMessage' = 'MERGE_MESSAGE'
}

# ....

$hashBody['squash_merge_commit_title'] = $squashMergeCommitTitleConversion.$SquashMergeCommitTitle

Similar feedback throughout.

Copy link
Contributor Author

@X-Guardian X-Guardian Feb 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we do this, then I think we really need to modify all GitHub.Repository objects returned by any function so that the Merge Commit property values match, otherwise this will be confusing to users of the module. If we change the current property values, merge_commit_title for example, then that is technically a breaking change. I could add additional properties, MergeCommitTitle for example with the Pascal case value, but then we are duplicating the properties.

Copy link
Contributor Author

@X-Guardian X-Guardian Mar 18, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@HowardWolosky, any response to this?

Copy link
Contributor

@HowardWolosky HowardWolosky Mar 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apologies for the delayed response here.

Great question -- I appreciate you bringing it up.

My general philosophy on this module is that I don't want to modify the raw return values that GitHub is providing, but that I will add properties that either add clarity/value, or assist in the continued functioning of the module.

Given that, I wouldn't want to modify the merge_commit_title / merge_commit_message values returned by GitHub. I'd be totally fine with adding a MergeCommitTitle/MergeCommitMessage/etc... property to the object when the equivalent GH property exists, using the naming/casing syntax that is part of the module, even if that makes the properties duplicative.

On this one, I don't feel super strong on needing those extra properties though. I don't think that the different casing/underscore usage on the GH object property will necessarily be confusing to users, but I can be easily swayed here. I'd happily approve a change that added the additional properties if the source ones existed in the GH object. I just want to keep the parameters consistent in casing convention. The additional properties on the object have been a bit more important to me when those could be used as parameters when piped into a different module function.

Copy link
Contributor Author

@X-Guardian X-Guardian Apr 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've update the parameter names as requested.

[string] $SquashMergeCommitTitle,

[ValidateSet('PR_BODY', 'COMMIT_MESSAGES', 'BLANK')]
[string] $SquashMergeCommitMessage,

[ValidateSet('PR_TITLE', 'MERGE_MESSAGE')]
[string] $MergeCommitTitle,

[ValidateSet('PR_TITLE', 'PR_BODY', 'BLANK')]
[string] $MergeCommitMessage,

[switch] $DeleteBranchOnMerge,

[switch] $IsTemplate,
Expand Down Expand Up @@ -211,6 +251,10 @@ filter New-GitHubRepository
if ($PSBoundParameters.ContainsKey('DisallowSquashMerge')) { $hashBody['allow_squash_merge'] = (-not $DisallowSquashMerge.ToBool()) }
if ($PSBoundParameters.ContainsKey('DisallowMergeCommit')) { $hashBody['allow_merge_commit'] = (-not $DisallowMergeCommit.ToBool()) }
if ($PSBoundParameters.ContainsKey('DisallowRebaseMerge')) { $hashBody['allow_rebase_merge'] = (-not $DisallowRebaseMerge.ToBool()) }
if ($PSBoundParameters.ContainsKey('SquashMergeCommitTitle')) { $hashBody['squash_merge_commit_title'] = $SquashMergeCommitTitle }
if ($PSBoundParameters.ContainsKey('SquashMergeCommitMessage')) { $hashBody['squash_merge_commit_message'] = $SquashMergeCommitMessage }
if ($PSBoundParameters.ContainsKey('MergeCommitTitle')) { $hashBody['merge_commit_title'] = $MergeCommitTitle }
if ($PSBoundParameters.ContainsKey('MergeCommitMessage')) { $hashBody['merge_commit_message'] = $MergeCommitMessage }
if ($PSBoundParameters.ContainsKey('DeleteBranchOnMerge')) { $hashBody['delete_branch_on_merge'] = $DeleteBranchOnMerge.ToBool() }
if ($PSBoundParameters.ContainsKey('IsTemplate')) { $hashBody['is_template'] = $IsTemplate.ToBool() }

Expand Down Expand Up @@ -1066,6 +1110,34 @@ filter Set-GitHubRepository
By default, rebase-merge pull requests will be allowed.
Specify this to disallow.

.PARAMETER SquashMergeCommitTitle
Specifies the default value for a squash merge commit title. This can be one of the
following values:
- PR_TITLE - default to the pull request's title.
- COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull
request's title (when more than one commit).

.PARAMETER SquashMergeCommitMessage
Specifies the default vaule for a squash merge commit message. This can be one of the
following values:
- PR_BODY - default to the pull request's body.
- COMMIT_MESSAGES - default to the branch's commit messages.
- BLANK - default to a blank commit message.

.PARAMETER MergeCommitTitle
Specifies the default value for a merge commit title. This can be one of the
following values:
- PR_TITLE - default to the pull request's title.
- MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request
#123 from branch-name).

.PARAMETER MergeCommitMessage
Specifies the default vaule for a merge commit message. This can be one of the
following values:
- PR_TITLE - default to the pull request's title.
- PR_BODY - default to the pull request's body.
- BLANK - default to a blank commit message.

.PARAMETER DeleteBranchOnMerge
Specifies the automatic deleting of head branches when pull requests are merged.

Expand Down Expand Up @@ -1170,6 +1242,18 @@ filter Set-GitHubRepository

[switch] $DisallowRebaseMerge,

[ValidateSet('PR_TITLE', 'COMMIT_OR_PR_TITLE')]
[string] $SquashMergeCommitTitle,

[ValidateSet('PR_BODY', 'COMMIT_MESSAGES', 'BLANK')]
[string] $SquashMergeCommitMessage,

[ValidateSet('PR_TITLE', 'MERGE_MESSAGE')]
[string] $MergeCommitTitle,

[ValidateSet('PR_TITLE', 'PR_BODY', 'BLANK')]
[string] $MergeCommitMessage,

[switch] $DeleteBranchOnMerge,

[switch] $IsTemplate,
Expand Down Expand Up @@ -1215,6 +1299,10 @@ filter Set-GitHubRepository
if ($PSBoundParameters.ContainsKey('DisallowSquashMerge')) { $hashBody['allow_squash_merge'] = (-not $DisallowSquashMerge.ToBool()) }
if ($PSBoundParameters.ContainsKey('DisallowMergeCommit')) { $hashBody['allow_merge_commit'] = (-not $DisallowMergeCommit.ToBool()) }
if ($PSBoundParameters.ContainsKey('DisallowRebaseMerge')) { $hashBody['allow_rebase_merge'] = (-not $DisallowRebaseMerge.ToBool()) }
if ($PSBoundParameters.ContainsKey('SquashMergeCommitTitle')) { $hashBody['squash_merge_commit_title'] = $SquashMergeCommitTitle }
if ($PSBoundParameters.ContainsKey('SquashMergeCommitMessage')) { $hashBody['squash_merge_commit_message'] = $SquashMergeCommitMessage }
if ($PSBoundParameters.ContainsKey('MergeCommitTitle')) { $hashBody['merge_commit_title'] = $MergeCommitTitle }
if ($PSBoundParameters.ContainsKey('MergeCommitMessage')) { $hashBody['merge_commit_message'] = $MergeCommitMessage }
if ($PSBoundParameters.ContainsKey('DeleteBranchOnMerge')) { $hashBody['delete_branch_on_merge'] = $DeleteBranchOnMerge.ToBool() }
if ($PSBoundParameters.ContainsKey('IsTemplate')) { $hashBody['is_template'] = $IsTemplate.ToBool() }
if ($PSBoundParameters.ContainsKey('Archived')) { $hashBody['archived'] = $Archived.ToBool() }
Expand Down
Loading