Skip to content

Publish GitHubRelease

apobekiaris edited this page May 23, 2019 · 3 revisions

schema: 2.0.0

Publish-GitHubRelease

SYNOPSIS

{{ Fill in the Synopsis }}

SYNTAX

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

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

Example 1

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

The above example is taken from the eXpandFramework GitHub-Release pipeline. https://github.com/eXpandFramework/Azure-Tasks/blob/dd68f11ed64ee9e47ed85050b5ab8e2bc74c2287/Scripts/Xpand-GitHub-Release.ps1#L97-L105

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: (All)
Aliases:

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

-Pass

{{ Fill Pass Description }}

Type: String
Parameter Sets: (All)
Aliases:

Required: True
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

-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

Star the project if you think it deserves it.

GitHub stars

Fork the project to extend and contribute.

GitHub forks

Clone this wiki locally
You can’t perform that action at this time.