Open
Description
Issue to track the implementation of the APIs for "merging" under the "Repository" section in #70
API reference: https://developer.github.com/v3/repos/merging/
I will update this issue with my proposals for the cmdlet names and parameters
Metadata
Metadata
Assignees
Labels
Type
Projects
Milestone
Relationships
Development
No branches or pull requests
Activity
raghav710 commentedon Jan 12, 2019
Here are my proposals for this cmdlet:
Name: Merge-GitHubRepositoryBranches
FileName: GitHubRepositoryMerge.ps1
It takes the following parameters
Checklists
I have read the contributing.md and will try to follow the same.
@HowardWolosky would like to know if there are anything additional I need to keep in mind before implementation
HowardWolosky commentedon Jan 12, 2019
Thanks @raghav710! Overall, this looks great. Looking forward to having this functionality.
Some minor feedback here:
AccessToken
andNoStatus
as the last parameters in the method, just for consistency with the rest of the module.Invoke-GHRestMethod
with the-ExtendedResult
parameter so that you can detect a201
vs a204
and be able to doWrite-Log -Level Warning
in the event that it's a204
explaining that there's nothing to merge.raghav710 commentedon Jan 15, 2019
@HowardWolosky thanks for the note on the
201
vs204
. Looking forward to getting this in :)HowardWolosky commentedon Jan 15, 2019
Me too.
The test may be hard to write though because we don't yet have API support for creating new pull requests... Something to keep in mind.
raghav710 commentedon Feb 19, 2019
@HowardWolosky I think I need the ability to create branches so I can add tests for this. Shall I concentrate on adding that and then come back to this?
raghav710 commentedon Feb 19, 2019
Also, here is a tentative PR: #89
I've tested the code manually using my own access token
HowardWolosky commentedon Feb 20, 2019
Thanks Raghav! I've given your tentative PR an initial code review. I do think that it would be best to only check in features that have corresponding tests that can help ensure that the module remains working as expected. If you're able to add the necessary, tested methods for creating branches so that you can add tests for this PR, that would be great.
I think you may run into some trouble writing tests for the refs API's too though, because per the documentation, you can't create new refs on empty repos...so, you'd have to make sure that it has content in it first. It's possible that using
-AutoInit
to create it with an empty README will be sufficient to satisfy that requirement however.