-
Notifications
You must be signed in to change notification settings - Fork 191
Adding Get Repository.Contents functionality #143
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.
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
Closed
Closed
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,104 @@ | ||
function Get-GitHubContent { | ||
<# | ||
.SYNOPSIS | ||
Retrieve the contents of a file or directory in a repository on GitHub. | ||
.DESCRIPTION | ||
Retrieve content from files on GitHub. | ||
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub | ||
.PARAMETER OwnerName | ||
Owner of the repository. | ||
If not supplied here, the DefaultOwnerName configuration property value will be used. | ||
.PARAMETER RepositoryName | ||
Name of the repository. | ||
If not supplied here, the DefaultRepositoryName configuration property value will be used. | ||
.PARAMETER Path | ||
The file path for which to retrieve contents | ||
.PARAMETER MediaType | ||
The format in which the API will return the body of the issue. | ||
Raw - Use the Raw media type to retrieve the contents of the file. | ||
Html - For markup files such as Markdown or AsciiDoc, you can retrieve the rendered HTML using the Html media type. | ||
.PARAMETER AccessToken | ||
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. | ||
.PARAMETER NoStatus | ||
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. | ||
|
||
.EXAMPLE | ||
Get-GitHubContent -OwnerName microsoft -RepositoryName PowerShellForGitHub -Path README.md -MediaType Html | ||
|
||
Get the Html output for the README.md file | ||
|
||
.EXAMPLE | ||
Get-GitHubContent -OwnerName microsoft -RepositoryName PowerShellForGitHub -Path LICENSE | ||
|
||
Get the Binary file output for the LICENSE file | ||
|
||
.EXAMPLE | ||
Get-GitHubContent -OwnerName microsoft -RepositoryName PowerShellForGitHub -Path Tests | ||
|
||
List the files within the "Tests" path of the repository | ||
#> | ||
Shazwazza marked this conversation as resolved.
Show resolved
Hide resolved
|
||
[CmdletBinding( | ||
SupportsShouldProcess, | ||
DefaultParametersetName = 'Elements')] | ||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification = "Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")] | ||
param( | ||
[Parameter(Mandatory, ParameterSetName = 'Elements')] | ||
[string] $OwnerName, | ||
|
||
[Parameter(Mandatory, ParameterSetName = 'Elements')] | ||
[string] $RepositoryName, | ||
|
||
[string] $Path, | ||
|
||
[ValidateSet('Raw', 'Html')] | ||
[string] $MediaType = 'Raw', | ||
|
||
[string] $AccessToken, | ||
|
||
[switch] $NoStatus | ||
) | ||
|
||
Write-InvocationLog | ||
|
||
$elements = Resolve-RepositoryElements -DisableValidation | ||
$OwnerName = $elements.ownerName | ||
$RepositoryName = $elements.repositoryName | ||
|
||
$telemetryProperties = @{ | ||
'OwnerName' = (Get-PiiSafeString -PlainText $OwnerName) | ||
'RepositoryName' = (Get-PiiSafeString -PlainText $RepositoryName) | ||
'Path' = $PSBoundParameters.ContainsKey('Path') | ||
} | ||
|
||
$uriFragment = [String]::Empty | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There's no value gained with this initialization given that you then go and explicitly set it to a new value at line 68 right after this in the same scope. |
||
$description = [String]::Empty | ||
|
||
$uriFragment = "/repos/$OwnerName/$RepositoryName/contents" | ||
|
||
if ($PSBoundParameters.ContainsKey('Path')) { | ||
$Path = $Path.TrimStart("\\", "/") | ||
$uriFragment += "/$Path" | ||
Shazwazza marked this conversation as resolved.
Show resolved
Hide resolved
|
||
$description = "Getting content for $Path in $RepositoryName" | ||
} | ||
else { | ||
$description = "Getting all content for in $RepositoryName" | ||
} | ||
|
||
$params = @{ | ||
'UriFragment' = $uriFragment | ||
'Description' = $description | ||
'AcceptHeader' = (Get-ContentMediaType -MediaType $MediaType) | ||
'AccessToken' = $AccessToken | ||
'TelemetryEventName' = $MyInvocation.MyCommand.Name | ||
'TelemetryProperties' = $telemetryProperties | ||
'NoStatus' = (Resolve-ParameterWithDefaultConfigurationValue -Name NoStatus -ConfigValueName DefaultNoStatus) | ||
} | ||
|
||
$result = Invoke-GHRestMethodMultipleResult @params | ||
|
||
return $result | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.