Skip to content

Latest commit

 

History

History
63 lines (38 loc) · 4.9 KB

README.md

File metadata and controls

63 lines (38 loc) · 4.9 KB
Raw

Git - Clone Git Repo

This custom step helps you clone a repository from a Git platform (like GitHub, GitLab etc.) to a folder in your filesystem.

Please refer this page which explains the motivation behind custom steps which surface Git integration functionality.

Here's a general idea of how this custom step works (the below is an animated GIF)

Git - Clone Git Repo

SAS Viya Version Support

Tested in Viya 4, Stable 2022.11

Which Git repositories are we talking about?

This custom step can connect to and pull code from public and restricted access (subject to access rights) Git repositories on GitHub or GitLab. While not tested, it can also access code from a corporate Git repository (for example, gitlab.company.com) if the SAS Viya environment is within the same Virtual Private Network (VPN).

Requirements

  1. A SAS Viya 4 environment (monthly release 2022.11 or later) with SAS Studio Flows.

  2. Configure Viya environment for Git integration: This is typically carried out by the administrator of your Viya environment. Some suggested properties are available here.

  3. SSH Key registration: Note that most Git repository hosting services (such as GitHub) require a SSH key to be registered with them and used for authentication. Ensure that you have followed instructions provided here. Here are instructions from GitHub on adding a SSH key to your GitHub account. It is recommended to use ECDSA SSH Keys when working with GitHub.

  4. Save SSH Keys in filesystem: Once you have your SSH keys generated, upload them to a folder within your filesystem. This is referred to within documentation here. To protect the integrity of your keys, ensure that only desired users have access to the folder where you are saving them to.

User Interface

Parameters

Parameters

Section - Git repository details

  1. Address of the Git repo you wish to clone: Note that it is of the format git@repo-address.git for SSH connections. A future release will also allow for providing addresses as per the Secure HTTPS connection (https://git-repo.git).
  2. Destination folder: This is a folder on your filesystem. Ensure this is an empty folder when cloning from a git repository.

Section - SSH details

  1. Path to your public key file.
  2. Path to your private key file.

For #s 2 and 3 above, ensure that your key files are saved in a filesystem folder with proper access rights. These keys contain credential information and are typically saved within folders which only the user can access.

  1. SSH user name: This is usually git. Leave the value as it is for most cases unless you are sure of the value. For example, if your SSH URL is “git@github.com:myname/myrepo.git” then the SSH user name is“git”.
  2. SSH password: Specify the password for your SSH key. If your SSH keys are not password protected, specify empty quotation marks ("" or '').

Output ports/tables

You can optionally specify two output ports.

  1. Git folder details table: Specify a table which will be used to store metadata about the git folder that has been pulled. In this initial release, only the top level folder is provided, which can be used for downstream tasks (such as referring to a file location). In future, we will list out all contents of the repo so that users can view the details of the files pulled.
  2. Status table: A simple status table to note the value of the return code after the GIT_CLONE function. The return codes are explained here.

Documentation

  1. Understanding Git Integration in SAS Studio
  2. Using Git Functions in SAS
  3. Configuration Properties for Git Integration

Installation & Usage

  1. Refer to the steps listed here.

Change Log

Version : 1.0. (25JAN2023)