Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 2.99 KB

UploadTo.md

File metadata and controls

35 lines (24 loc) · 2.99 KB

Configuring UploadTo Options - GitHub and Box.com

Some of the DevOps actions either require or have the option to upload files to a location accessible over the Internet. The choices we offer for now are GitHub and Box.com. This page is a guide for how to configure each.

Once the configuration for GitHub and/or Box.com exists, it can be referenced from UploadTo entries of sections that generate files. For example, this configuration parameter triggers the upload of the generated Java JAR file to both the GitHub and Box.com locations, using the specifications in their corresponding configuration sections:


GitHub Configuration

As with all other configuration driven actions, the moniker for the default section is "GitHub". Multiple configurations can be created and used, as long as they are defined as having a "GitHub" type using the line below. The Type entry is implied for the default section with the "GitHub" moniker:

This is a sample configuration with the coordinates of a GitHub location where files can be uploaded by other DevOps actions. This configuration is applicable for a local deployment. For the DevOps app service, the configuration follows the format in the starter cloud config file.

  <add key="GitHub.GitHubRepo" value="InRule/DevOps"/>
  <add key="GitHub.GitHubFolder" value="JARs"/>
  <add key="GitHub.GitHubProductName" value="MyApplication"/>
  <add key="GitHub.GitHubProductVersion" value="1"/>
  <add key="GitHub.GitHubToken" value="ghp_xxxxxxxxxxxxxxxxxxxxxxxxx"/>

We will use this GitHub location as example for extracting the values below: https://github.com/InRule/ProjectDevOps/tree/main/Tests

Configuration Key Comments
GitHub.GitHubRepo This would be "InRule/ProjectDevOps" in the example URI above, for owner/repository.
GitHub.GitHubFolder This is the folder where the files will be uploaded. It would be "Tests" in the example URI.
GitHub.GitHubProductName The local folder used as the temporary location for the rule application file before being sent to the irDistribution service. For the Azure deployment with DevOps service, this location is overridden with the default TEMP location for the app service.
GitHub.GitHubProductVersion The local folder used as the temporary location for saving the generated Java JAR file before upload to either GitHub or Box.com. For the Azure deployment with DevOps service, this location is overridden with the default TEMP location for the app service.
GitHub.GitHubToken Personal access tokens (PATs) are an alternative to using passwords for authentication to GitHub when using the GitHub API or the command line. Follow these instructions to create the Personal Access Token.