GitHubRepositories: Add New-GitHubRepositoryFromTemplate Function by X-Guardian · Pull Request #221 · microsoft/PowerShellForGitHub

Simon Heather (X-Guardian) · 2020-06-04T19:57:24Z

Description

This PR adds a new function New-GitHubRepositoryFromTemplate to the GitHubRepositories module. This function creates a new GitHub repository from a specified template repository.

Parameters

Name	Type	Description
RepositoryName	Mandatory String	Name of the repository to be created.
TemplateOwnerName	Mandatory String	Owner of the template repository.
TemplateRepositoryName	Mandatory String	Name of the template repository.
OwnerName	String	Owner of the repository to be created. If not specified, the DefaultOwnerName configuration property value will be used.
Description	String	A short description of the repository.
Private	Switch	By default, this repository will be created Public. Specify this to create a private repository.
AccessToken	String	If provided, this will be used as the AccessToken for authentication with the REST Api. Otherwise, will attempt to use the configured value or will run unauthenticated.
NoStatus	Switch	If this switch is specified, long-running commands will run on the main thread with no commandline status update. When not specified, those commands run in the background, enabling the command prompt to provide status information. If not supplied here, the DefaultNoStatus configuration property value will be used.

Issues Fixed

FixesNew Function Proposal: New-GitHubRepositoryFromTemplate #220

References

Create a repository using a template

Checklist

You actually ran the code that you just wrote, especially if you did just "one last quick change".
Comment-based help added/updated, including examples.
Static analysis
is reporting back clean.
New/changed code adheres to our coding guidelines.
Changes to the manifest file follow the manifest guidance.
Unit tests were added/updated and are all passing. See testing guidelines.
Relevant usage examples have been added/updated in USAGE.md.
If desired, ensure your name is added to our Contributors list

Simon Heather (X-Guardian) · 2020-06-07T13:28:27Z

Can we trigger the CI for this PR?

Howard Wolosky (HowardWolosky) · 2020-06-09T21:18:11Z

I'll kick off a CI build a little bit later today after the current one ends.

Howard Wolosky (HowardWolosky) · 2020-06-10T15:50:41Z

/azp run PowerShellForGitHub-CI

azure-pipelines · 2020-06-10T15:50:51Z

Azure Pipelines successfully started running 1 pipeline(s).

Simon Heather (X-Guardian) · 2020-06-12T18:40:11Z

Can we trigger the CI for this PR?

Howard Wolosky (HowardWolosky) · 2020-06-12T18:43:29Z

/azp run PowerShellForGitHub-CI

azure-pipelines · 2020-06-12T18:43:40Z

Azure Pipelines successfully started running 1 pipeline(s).

Simon Heather (X-Guardian) · 2020-06-12T19:13:37Z

A weird CI failure on MacOS for the static code analysis step:

2|$results=Invoke-ScriptAnalyzer-Path ./ –Recurse
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| Collection was modified; enumeration operation may not execute.

May be related to this: Collection was modified; enumeration operation may not execute when running Invoke-ScriptAnalyzer

can you run the CI again and see if it is consistent?

Howard Wolosky (HowardWolosky) · 2020-06-12T19:56:16Z

Yeah, I've been seeing that pop up from time to time. I've just been waiting out a fix for that bug.

Howard Wolosky (HowardWolosky) · 2020-06-12T19:56:19Z

/azp run PowerShellForGitHub-CI

azure-pipelines · 2020-06-12T19:56:28Z

Azure Pipelines successfully started running 1 pipeline(s).

Christoph Bergmeister (bergmeister) · 2020-06-13T11:52:31Z

Howard Wolosky (@HowardWolosky) Can you please open a new issue in the PSScriptAnalyzer repo with steps to repro: https://github.com/PowerShell/PowerShell/issues/new?assignees=&labels=Issue-Question&template=Bug_Report.md&title=My+bug+report
The referenced bug PowerShell/PSScriptAnalyzer#1516 that you mention is specific to the new 1.19.0 release and only when using the PSUseCorrectCasing rule that is not run by default by Invoke-ScriptAnalyzer. Therefore your issue is likely a completely different one despite the error message being the same. I cloned this branch locally and cannot reproduce unfortunately :-(
I opened PR #236 to help you log and report the error the next time.

…rove ScriptAnalyzer installation to not skip publisher and check and not allow clobber (#236) #221 reported that this repo causes PSScriptAnalyzer to sporadically throw an error. In order to report the full error needed for analysis, report the full stack trace. In order to make this easier, I've updated `Invoke-ScriptAnalyzer` to run within a `try/catch using -ErrorAction Stop`, and report any error found with `$_.Exception.StackTrace` before re-throwing the error.

Simon Heather (X-Guardian) · 2020-06-15T16:31:43Z

Can we trigger the CI for this PR?

Howard Wolosky (HowardWolosky) · 2020-06-19T02:21:33Z

Can we trigger the CI for this PR?

I can once the conflicts stemming from #242 have been resolved.

Howard Wolosky (HowardWolosky)

Thanks for adding this functionality!

Some feedback is included for you to review.

Simon Heather (X-Guardian) · 2020-06-21T08:51:24Z

Can we trigger the CI for this PR?

Howard Wolosky (HowardWolosky) · 2020-06-21T15:48:22Z

/azp run PowerShellForGitHub-CI

azure-pipelines · 2020-06-21T15:48:57Z

Azure Pipelines successfully started running 1 pipeline(s).

Howard Wolosky (HowardWolosky)

Super minor additional changes, and then we can get this merged. Thanks for the new feature!

Howard Wolosky (HowardWolosky)

Just noticed one bug before I was about to run CI. I'll kick off CI and then merge this in once that gets fixed.

Co-authored-by: Howard Wolosky <HowardWolosky@users.noreply.github.com>

Simon Heather (X-Guardian) · 2020-06-24T19:47:48Z

Howard Wolosky (@HowardWolosky), ready for CI.

Howard Wolosky (HowardWolosky) · 2020-06-24T23:22:51Z

/azp run PowerShellForGitHub-CI

azure-pipelines · 2020-06-24T23:23:01Z

Azure Pipelines successfully started running 1 pipeline(s).

Simon Heather (X-Guardian) · 2020-06-26T17:29:57Z

Howard Wolosky (@HowardWolosky) , can we trigger the CI for this PR?

Howard Wolosky (HowardWolosky) · 2020-06-26T17:48:59Z

Sure thing. Will kick it off once the current one completes, and then get this merged in.

Howard Wolosky (HowardWolosky) · 2020-06-26T20:10:49Z

/azp run PowerShellForGitHub-CI

azure-pipelines · 2020-06-26T20:10:59Z

Azure Pipelines successfully started running 1 pipeline(s).

Howard Wolosky (HowardWolosky) · 2020-06-30T18:47:18Z

Simon Heather (@X-Guardian) - looks like this work doesn't fully support pipeline input, and the tests aren't sufficiently figuring that out either.

You're not capturing $RepositoryName = $elements.repositoryName at the top, which means that input from $Uri will never resolve correctly.

PowerShellForGitHub/GitHubRepositories.ps1

Lines 363 to 366 in d96541e

$elements=Resolve-RepositoryElements-BoundParameters $PSBoundParameters
$OwnerName=$elements.ownerName
$telemetryProperties=@{ 

You're passing in -WhatIf which meant that you missed the bug in the method, since the failure was only seen as an exception thrown from the GitHub API itself when RepositoryName was missing in the uri fragment itself which won't occur due to the -WhatIf (the pipeline input needs to be a real separate test):

PowerShellForGitHub/Tests/GitHubRepositories.tests.ps1

Lines 332 to 333 in d96541e

 { $templateRepo|New-GitHubRepositoryFromTemplate@newGitHubRepositoryFromTemplateParms-WhatIf } |
 Should -Not-Throw 

Once you make those changes, I'm seeing some additional failures that start to occur.

Want to take a crack at a fix?

Added in microsoft#221, `New-GitHubRepositoryFromTemplate was not capturing the passed-in value for the RepositoryName if provided via a Uri parameter. There was a pipeline test in place, however it missed this fact because it was only testing the pipeline input scenario using `-WhatIf`, and the error was only found when calling the actual REST API and GitHub noticed that the `RepositoryName` was missing from the URI.

Howard Wolosky (HowardWolosky) · 2020-06-30T19:06:06Z

I put out a fix with #259

…#259) Added in #221, `New-GitHubRepositoryFromTemplate was not capturing the passed-in value for the RepositoryName if provided via a Uri parameter. There was a pipeline test in place, however it missed this fact because it was only testing the pipeline input scenario using `-WhatIf`, and the error was only found when calling the actual REST API and GitHub noticed that the `RepositoryName` was missing from the URI.

Simon Heather (X-Guardian) marked this pull request as ready for review June 12, 2020 22:53

Christoph Bergmeister (bergmeister) mentioned this pull request Jun 13, 2020
CI: Report full stack trace if ScriptAnalyzer throws an error and improve ScriptAnalyzer installation to not skip publisher and check and not allow clobber #236
Merged
8 tasks

Howard Wolosky (HowardWolosky) suggested changes Jun 19, 2020
View reviewed changes

Simon Heather (X-Guardian) added 8 commits June 19, 2020 18:44

New-GitHubRepositoryFromTemplate
3b8bb4c

Add Repositories Usage
d4e432f

Update contributors
cd2b4d4

Add tests
8b9dcae

Add PositionalBinding
2a22216

Update tests
66cf239

Remove redundandant Invocation parameter
f0d7482

Fix review comments and add Pipeline support
d7901d0

Merge branch 'master' into New-GitHubRepositoryFromTemplate
847119c

Howard Wolosky (HowardWolosky) added the waiting for update Waiting for an update to the PR before the next review label Jun 20, 2020

Merge branch 'master' into New-GitHubRepositoryFromTemplate
47b2747

Simon Heather (X-Guardian) mentioned this pull request Jun 21, 2020
GitHubRepositories: Add Output Type Views #205
Merged

Howard Wolosky (HowardWolosky) suggested changes Jun 24, 2020
View reviewed changes

Fix review comments
68ea049

Howard Wolosky (HowardWolosky) suggested changes Jun 24, 2020
View reviewed changes

Comment threadGitHubRepositories.ps1 Outdated
Comment threadGitHubRepositories.ps1 Outdated

Simon Heather (X-Guardian)and others added 3 commits June 24, 2020 20:44

Update GitHubRepositories.ps1
7d06169
Co-authored-by: Howard Wolosky <HowardWolosky@users.noreply.github.com>

Merge branch 'master' into New-GitHubRepositoryFromTemplate
ba31c0a

Update GitHubRepositories.ps1
8c58a55
Co-authored-by: Howard Wolosky <HowardWolosky@users.noreply.github.com>

Merge branch 'master' into New-GitHubRepositoryFromTemplate
10ed1a7

Merge branch 'master' into New-GitHubRepositoryFromTemplate
bb0ec33

Howard Wolosky (HowardWolosky) removed the waiting for update Waiting for an update to the PR before the next review label Jun 26, 2020

Howard Wolosky (HowardWolosky) approved these changes Jun 26, 2020
View reviewed changes

Howard Wolosky (HowardWolosky) merged commit d96541e into microsoft:masterJun 26, 2020

Howard Wolosky (HowardWolosky) mentioned this pull request Jun 30, 2020
Fix pipeline support and testing for New-GitHubRepositoryFromTemplate #259
Merged
9 tasks

Uh oh!

Conversation

Simon Heather (X-Guardian) commented Jun 4, 2020• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Parameters

Issues Fixed

References

Checklist

Uh oh!

Simon Heather (X-Guardian) commented Jun 7, 2020

Uh oh!

Howard Wolosky (HowardWolosky) commented Jun 9, 2020

Uh oh!

Howard Wolosky (HowardWolosky) commented Jun 10, 2020

Uh oh!

azure-pipelinesBot commented Jun 10, 2020

Uh oh!

Simon Heather (X-Guardian) commented Jun 12, 2020

Uh oh!

Howard Wolosky (HowardWolosky) commented Jun 12, 2020

Uh oh!

azure-pipelinesBot commented Jun 12, 2020

Uh oh!

Simon Heather (X-Guardian) commented Jun 12, 2020

Uh oh!

Howard Wolosky (HowardWolosky) commented Jun 12, 2020

Uh oh!

Howard Wolosky (HowardWolosky) commented Jun 12, 2020

Uh oh!

azure-pipelinesBot commented Jun 12, 2020

Uh oh!

Christoph Bergmeister (bergmeister) commented Jun 13, 2020• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Simon Heather (X-Guardian) commented Jun 15, 2020

Uh oh!

Howard Wolosky (HowardWolosky) commented Jun 19, 2020

Uh oh!

Howard Wolosky (HowardWolosky) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Simon Heather (X-Guardian) commented Jun 21, 2020

Uh oh!

Howard Wolosky (HowardWolosky) commented Jun 21, 2020

Uh oh!

azure-pipelinesBot commented Jun 21, 2020

Uh oh!

Howard Wolosky (HowardWolosky) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Howard Wolosky (HowardWolosky) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Simon Heather (X-Guardian) commented Jun 24, 2020

Uh oh!

Howard Wolosky (HowardWolosky) commented Jun 24, 2020

Uh oh!

azure-pipelinesBot commented Jun 24, 2020

Uh oh!

Simon Heather (X-Guardian) commented Jun 26, 2020

Uh oh!

Howard Wolosky (HowardWolosky) commented Jun 26, 2020

Simon Heather (X-Guardian) commented Jun 4, 2020•
edited
Loading

Christoph Bergmeister (bergmeister) commented Jun 13, 2020•
edited
Loading