Ensure GitHub Release
- 14 May 2021
- 1 Minute to read
-
Print
-
DarkLight
-
PDF
Ensure GitHub Release
- Updated on 14 May 2021
- 1 Minute to read
-
Print
-
DarkLight
-
PDF
This is generated from the built in components of BuildMaster 7.0.0, and may be different than what you have installed (especially if you have extensions); go to [User Icon] -> Documentation within your BuildMaster instance to see exactly what operations are available.
Ensure GitHub Release
Creates or updates a tagged release in a GitHub repository.
Script usage:
GitHub::Ensure-Release( [From: <text>], [UserName: <text>], [Password: <SecureString>], [Organization: <text>], [Repository: <text>], [ApiUrl: <text>], Tag: <text>, [Target: <text>], [Title: <text>], [Description: <text>], [Draft: <true/false>], [Prerelease: <true/false>] );
Arguments:
| Name | Format | Script Usage | Usage Notes |
|---|---|---|---|
| From GitHub resource | text | From | |
| User name | text | UserName | |
| Password | SecureString | Password | |
| Organization name | text | Organization | |
| Repository name | text | Repository | |
| API URL | text | ApiUrl | |
| ☆ 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. |
| Description | text | Description | Release notes, formatted as Markdown. Leave blank to keep the existing release notes. |
| Is draft | true/false | Draft | |
| Is prerelease | true/false | Prerelease |
Was this article helpful?
