Skip to content

Publish GitHubRelease

apobekiaris edited this page Sep 4, 2020 · 9 revisions

external help file: XpandPwsh.Cmdlets.dll-Help.xml Module Name: XpandPwsh online version: https://go.microsoft.com/fwlink/?LinkID=2097043 schema: 2.0.0

Publish-GitHubRelease

SYNOPSIS

Publish a release for a Github repository.

SYNTAX

Owner

Publish-GitHubRelease -Repository <String> -ReleaseName <String> [-ReleaseNotes <String>] [-Files <String[]>]
 [-Prerelease] [-Draft] -Owner <String> -Organization <String> -Pass <String> [-WhatIf] [-Confirm]
 [<CommonParameters>]

Token

Publish-GitHubRelease -Repository <String> -ReleaseName <String> [-ReleaseNotes <String>] [-Files <String[]>]
 [-Prerelease] [-Draft] -Organization <String> -Token <String> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Publish a release for a Github repository.

EXAMPLES

Example 1

PS C:\> $publishArgs = (@{
    Repository   = "eXpand"
    ReleaseName  = $version
    ReleaseNotes = (Get-GitHubReleaseNotes)
    Files        = $files
    Draft        = $true
}+$cred)
Publish-GitHubRelease @publishArgs

Publish an eXpandFramework GitHub release.

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-Draft

{{ Fill Draft Description }}

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Files

{{ Fill Files Description }}

Type: String[]
Parameter Sets: (All)
Aliases:

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

-Organization

{{ Fill Organization Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-Owner

{{ Fill Owner Description }}

Type: String
Parameter Sets: Owner
Aliases:

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

-Pass

{{ Fill Pass Description }}

Type: String
Parameter Sets: Owner
Aliases:

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

-Prerelease

{{ Fill Prerelease Description }}

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ReleaseName

{{ Fill ReleaseName Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-ReleaseNotes

{{ Fill ReleaseNotes Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-Repository

{{ Fill Repository Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-Token

{{ Fill Token Description }}

Type: String
Parameter Sets: Token
Aliases:

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
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

None

OUTPUTS

Octokit.Release

NOTES

RELATED LINKS

image

image


Star the project if you think it deserves it.

GitHub stars

Fork the project to extend and contribute.

GitHub forks

Clone this wiki locally