The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.
For a list of other such plugins, see the Pipeline Steps Reference page.
createGitHubRelease: createGitHubReleasebodyFile : String (optional)
File containing text describing the contents of the tag. The text can be formatted with Markdown.
bodyText : String (optional)
Text describing the contents of the tag. The text can be formatted with Markdown.
categoryName : String (optional)
If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "Managing categories for discussions in your repository."
commitish : String (optional)
Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.
credentialId : String (optional)
The credential used to connect to GitHub. Supported kinds: "Secret text" (personal access token) or "GitHub App" (requires the GitHub Branch Source plugin).
draft : boolean (optional)
true to create a draft (unpublished) release, false to create a published one.
Default: false
githubServer : String (optional)
The GitHub Server to connect to.
The default value of blank will connect to the public instance of GitHub. https://api.github.com/
name : String (optional)
The name of the release. If blank the tag will be used.
prerelease : boolean (optional)
true to identify the release as a prerelease. false to identify the release as a full release.
Default: false
repository : String (optional)
The GitHub repository to connect to.
Example: jenkinsci/jenkins
tag : String (optional)
The name of the name of the git tag to create.
listGitHubReleases: listGitHubReleasescredentialId : String (optional)
The credential used to connect to GitHub. Supported kinds: "Secret text" (personal access token) or "GitHub App" (requires the GitHub Branch Source plugin).
githubServer : String (optional)
The GitHub Server to connect to.
The default value of blank will connect to the public instance of GitHub. https://api.github.com/
includeDrafts : boolean (optional)
repository : String (optional)
The GitHub repository to connect to.
Example: jenkinsci/jenkins
sortAscending : boolean (optional)
sortBy : String (optional)
tagNamePattern : String (optional)
Java regex that will be used to find() releases. The find() method on the pattern will be called.
Examples:
Java Regex Tester is a helpful resource.
uploadGithubReleaseAsset: uploadGithubReleaseAssettagName : String (optional)
The name of the tag that will be used to search for the release.
credentialId : String (optional)
The credential used to connect to GitHub. Supported kinds: "Secret text" (personal access token) or "GitHub App" (requires the GitHub Branch Source plugin).
githubServer : String (optional)
The GitHub Server to connect to.
The default value of blank will connect to the public instance of GitHub. https://api.github.com/
overwrite : boolean (optional)
Remove assets from the release before uploading if they exist already.
repository : String (optional)
The GitHub repository to connect to.
Example: jenkinsci/jenkins
uploadAssets (optional)
filePath : String (optional)
contentType : String (optional)
Please submit your feedback about this page through this quick form.
Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?
See existing feedback here.