Plug-in Documentation

GitHub-Release

Overview

The Github Release plug-in automates importing artifacts from a GitHub repository. You can import ZIP and TAR archive files into your UrbanCode Deploy server. The plug-in creates a component version of release in the UrbanCode Deploy server for the specified release being imported. You can specify a specific version to import or use the default to import the latest version.

When creating the component, youll supply information described on the Import Version step. After the component is created use the Components page in the user interface to import a version of the artifacts.

This plug-in includes one step which has no input properties:

Step palette

To access this plug-in in the palette, click Source and Repositories > GitHub Release.

Installation

No special steps are required for installation. See Installing plug-ins in UrbanCode.

History

Version 3

  • PH24721 – GIT-RELEASE UCD PLUG-IN does not use BASE64-ENCODE for USERNAME/ PASSWORD / AUTHENTICATION HEADER.

Version 2

  • Fixing CVE:CVE-2019-4233.

Version 1

  • Initial release of GitHub Release source configuration plugin.

Steps

Process steps in the GitHub Release plug-in

Import Version

Creates a new component version and downloads the archive to the CodeStation.

This step has no input properties.

Roles in the GitHub Release plug-in

The plug-in adds these roles automatically to resources. You cannot add these roles
manually.

GitHubReleaseComponentProperties

Properties for the GitHubReleaseComponentProperties role
Name Type Description
Download Tarball Boolean Select to download a tarball of the source code.
Download Zipball Boolean Select to download a zipball of the source code.
Extensions of files to Convert String A list of file extension to be converted to a new Charset when downloaded. Separate
each item with a comma. For example: zip,tar.gz.
GitHub Repository URL String The base URL of the repository on the GitHub. For example:https://api.github.com/repos/ibm-datapower/datapower-configuration-manager.
Password Password The password to use to connnect to the GitHub Repository.
Preserve Execute Permissions Boolean For Linux and UNIX operating systems, select this property to
retain the execute permissions of each file.
User String The username to use to connect to the GitHub repository, if authentication is required.

GitHubReleaseImportProperties

Properties for the GitHubReleaseImportProperties role
Name Type Description
GitHub Release Tag Name String Import the GitHub tag name. For example: 20.