Skip to content

Split GitHubUri

Howard Wolosky edited this page Oct 5, 2020 · 1 revision

Split-GitHubUri

SYNOPSIS

Extracts the relevant elements of a GitHub repository Uri and returns the requested element.

SYNTAX

RepositoryName (Default)

Split-GitHubUri -Uri <String> [-RepositoryName] [<CommonParameters>]

OwnerName

Split-GitHubUri -Uri <String> [-OwnerName] [<CommonParameters>]

DESCRIPTION

Extracts the relevant elements of a GitHub repository Uri and returns the requested element.

Currently supports retrieving the OwnerName and the RepositoryName, when available.

The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub

EXAMPLES

EXAMPLE 1

Split-GitHubUri -Uri 'https://github.com/microsoft/PowerShellForGitHub'

PowerShellForGitHub

EXAMPLE 2

Split-GitHubUri -Uri 'https://github.com/microsoft/PowerShellForGitHub' -RepositoryName

PowerShellForGitHub

EXAMPLE 3

Split-GitHubUri -Uri 'https://github.com/microsoft/PowerShellForGitHub' -OwnerName

microsoft

EXAMPLE 4

Split-GitHubUri -Uri 'https://github.com/microsoft/PowerShellForGitHub'

@{'ownerName' = 'microsoft'; 'repositoryName' = 'PowerShellForGitHub'}

PARAMETERS

-OwnerName

Returns the Owner Name from the Uri if it can be identified.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: OwnerName
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-RepositoryName

Returns the Repository Name from the Uri if it can be identified.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: RepositoryName
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Uri

The GitHub repository Uri whose components should be returned.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

[String]

OUTPUTS

[PSCustomObject] - The OwnerName and RepositoryName elements from the provided URL

NOTES

RELATED LINKS

PowerShellForGitHub

Docs

PowerShellForGitHub

Functions

Clone this wiki locally