---
title: "Ensure-Release"
---
Creates or updates a tagged release in a GitHub repository.
GitHub::Ensure-Release(
[From: <text>],
[UserName: <text>],
[Password: <text>],
[Organization: <text>],
[Repository: <text>],
[ApiUrl: <text>],
Tag: <text>,
[Target: <text>],
[Title: <text>],
[Description: <text>],
[Draft: <true/false>],
[Prerelease: <true/false>]
);
Name | Format | Script Usage | Usage Notes |
---|---|---|---|
From GitHub resource | text | From | |
User name | text | UserName | Not specifying will "Use user name from GitHub resource's credentials". |
Password | text | Password | Not specifying will "Use password from GitHub resource's credentials". |
Organization name | text | Organization | Not specifying will "Use organization from Github resource". |
Repository name | text | Repository | Not specifying will "Use repository from Github resource". |
API URL | text | ApiUrl | Not specifying will "Use URL from Github resource.". |
☆ Tag name | text | Tag | This argument is required. |
Target commit | text | Target | May be specified as a branch name, a commit hash, or left blank for the latest commit on the default branch (usually master). |
Title | text | Title | If left blank, the tag name will be used for new releases and existing releases will keep their original title. Value note: "(keep existing)". |
Description | text | Description | Release notes, formatted as Markdown. Leave blank to keep the existing release notes. Value note: "(keep existing)". |
Is draft | true/false | Draft | Value note: "(keep existing)". |
Is prerelease | true/false | Prerelease | Value note: "(keep existing)". |