Set GitHubContent - X-Guardian/PowerShellForGitHub GitHub Wiki
Sets the contents of a file or directory in a repository on GitHub.
Set-GitHubContent -OwnerName <String> -RepositoryName <String> [-Path] <String> [-CommitMessage] <String>
[-Content] <String> [-Sha <String>] [-BranchName <String>] [-CommitterName <String>]
[-CommitterEmail <String>] [-AuthorName <String>] [-AuthorEmail <String>] [-AccessToken <String>] [-NoStatus]
[-WhatIf] [-Confirm] [<CommonParameters>]
Set-GitHubContent [-Uri] <String> [-Path] <String> [-CommitMessage] <String> [-Content] <String>
[-Sha <String>] [-BranchName <String>] [-CommitterName <String>] [-CommitterEmail <String>]
[-AuthorName <String>] [-AuthorEmail <String>] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm]
[<CommonParameters>]
Sets the contents of a file or directory in a repository on GitHub.
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
Set-GitHubContent -OwnerName microsoft -RepositoryName PowerShellForGitHub -Path README.md -CommitMessage 'Adding README.md' -Content '# README' -BranchName master
Sets the contents of the README.md file on the master branch of the PowerShellForGithub repository.
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: FalseThe email of the author of the commit. Defaults to the email of the authenticated user if not specified. If specified, AuthorName must also be specified.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe name of the author of the commit. Defaults to the name of the authenticated user if not specified. If specified, AuthorEmail must also be specified.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe branch, or defaults to the default branch if not specified.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe Git commit message.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe email of the committer of the commit. Defaults to the email of the authenticated user if not specified. If specified, CommitterName must also be specified.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe name of the committer of the commit. Defaults to the name of the authenticated user if not specified. If specified, CommiterEmail must also be specified.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe new file content.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIf 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.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseOwner of the repository. If not supplied here, the DefaultOwnerName configuration property value will be used.
Type: System.String
Parameter Sets: Elements
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe file path for which to set contents.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseName of the repository. If not supplied here, the DefaultRepositoryName configuration property value will be used.
Type: System.String
Parameter Sets: Elements
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe SHA value of the current file if present. If this parameter is not provided, and the file currently exists in the specified branch of the repo, it will be read to obtain this value.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseUri 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: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.