Get GitHubCodeOfConduct

Get-GitHubCodeOfConduct

SYNOPSIS

Gets Codes of Conduct or a specific Code of Conduct from GitHub.

SYNTAX

Elements

Get-GitHubCodeOfConduct [-OwnerName <String>] [-RepositoryName <String>] [-AccessToken <String>]
 [<CommonParameters>]

Uri

Get-GitHubCodeOfConduct -Uri <String> [-AccessToken <String>] [<CommonParameters>]

Individual

Get-GitHubCodeOfConduct -Key <String> [-AccessToken <String>] [<CommonParameters>]

DESCRIPTION

Gets Codes of Conduct or a specific Code of Conduct from GitHub.

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

EXAMPLES

EXAMPLE 1

Get-GitHubCodeOfConduct

Returns metadata about popular Codes of Conduct

EXAMPLE 2

Get-GitHubCodeOfConduct -Key citizen_code_of_conduct

Gets the content of the 'Citizen Code of Conduct'

EXAMPLE 3

Get-GitHubCodeOfConduct -OwnerName microsoft -RepositoryName PowerShellForGitHub

Gets the content of the Code of Conduct file for the microsoft\PowerShellForGitHub repository if one is detected.

It may be necessary to convert the content of the file. Check the 'encoding' property of the result to know how 'content' is encoded. As an example, to convert from Base64, do the following:

[System.Text.Encoding]::UTF8.GetString([System.Convert]::FromBase64String($result.content))

PARAMETERS

-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.

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

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

-Key

The unique key of the Code of Conduct to retrieve the content for. If not specified, all Codes of Conduct will be returned.

Type: System.String
Parameter Sets: Individual
Aliases: CodeOfConductKey

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

-OwnerName

Owner of the repository. If not supplied here, the DefaultOwnerName configuration property value will be used.

Type: System.String
Parameter Sets: Elements
Aliases:

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

-RepositoryName

Name of the repository. If not supplied here, the DefaultRepositoryName configuration property value will be used.

Type: System.String
Parameter Sets: Elements
Aliases:

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

-Uri

Uri for the repository. The OwnerName and RepositoryName will be extracted from here instead of needing to provide them individually.

Type: System.String
Parameter Sets: Uri
Aliases: RepositoryUrl

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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]

GitHub.Branch

GitHub.Content

GitHub.Event

GitHub.Issue

GitHub.IssueComment

GitHub.Label

GitHub.Milestone

GitHub.PullRequest

GitHub.Project

GitHub.ProjectCard

GitHub.ProjectColumn

GitHub.Reaction

GitHub.Release

GitHub.ReleaseAsset

GitHub.Repository

OUTPUTS

GitHub.CodeOfConduct

NOTES

RELATED LINKS