GitHub Repositories

In this section, the Syndeia Web Dashboard capabilities for GitHub repositories are presented.

Pre-Requisites

Check supported versions of GitHub here: Syndeia 3.5 - Integration Compatibility

Tutorials

See the GitHub integration tutorial for Syndeia Web Dashboard - Part 6 - GitHub on Web Dashboard.

Add a GitHub Repository

(1) Click the Repositories icon in the LHS menu pane.

(2) Select GitHub in the list of Repository types on the LHS and click on the + icon to add a new GitHub repository, as shown below.

Open

(3) Fill out the details for your GitHub server (repository), as shown below, and click the Create button.

• URL - Base URL of your GitHub repository.

  • For GitHub cloud (www.github.com), use https://api.github.com.

  • For GitHub Enterprise deployed in your organization, check the URL from your GitHub Enterprise administrator.

• Name - Name of the GitHub repository. Provide a unique name to distinguish this GitHub repository from others you may add.

• Description - Description of the GitHub repository

• Authentication type - Basic (default)

• Username - Username to sign in to your GitHub repository. Enter the same username that you use on the GitHub web client.

• Password - Password to sign in to your GitHub repository.

  • For GitHub cloud (www.github.com), enter the Personal Access Token token to sign in. To create a Personal Access Token, refer here - https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token

  • For GitHub Enterprise, use the same password you use to sign in to GitHub web client.

Open

Browse a GitHub Repository

(1) Expand the GitHub repository after it has been added.

(2) If your repository details are correct, Syndeia Cloud will try to sign in to the GitHub repository and display three categories of Git Repositories, as shown below:

• Repositories as org member - Lists all Organizations that you are a member of. Expand any Organization to view the Git Repositories accessible to you in that Organization.

• Repositories as collaborator - Lists all Git Repositories accessible to you as a collaborator.

• Repositories as owner - Lists all Git Repositories accessible to you as an owner.

(3) Expand a Git Repository to view contents organized by Branches, Commits, Issues, and Tags

(4) Branches - Expand the Branches category to view all Branches in the Git Repository, as shown in the view above. Expand a Branch to views its file and folder contents, as shown in the view below.

(5) Commits - Expand the Commits category to view all Commits in the Git Repository.

(6) Issues- Expand the Issues category to view all Issues in the Git Repository, as shown in the view below.

(7) Tags - Expand the Tags category to view all Tags in the Git Repository, as shown in the view below.

Search a GitHub Repository

Users can search for Git Repositories or resources in a Git Repository. Click on the Search icon on the RHS to see the Search tab.

(1) Search for Git Repositories

• Select the Repository option, as shown below.

• Specify any text string contained in the name of the Git Repositories you are searching for.

• Click the Search button. Results are shown on the RHS.

(2) Search resources in a Git Repository

• Select the Resources in a repository option, as shown below.

• Select Repository Scope to filter Git Repositories as an Org member, Collaborator, or Owner.

• Select a specific Git Repository. You will need to select an Organization if the Repository Scope was selected as Org member.

• Select the type of resource you want to search in the selected Git Repository. You can search for Branches, Commits, Issues, or Tags in a Git Repository.

• Branch search

  • Select GitHub Branch in the Type dropdown, as shown below.

  • Specify any text string contained in the names of the Branches you are searching for.

  • Click the Search button. The result will be shown on the RHS.

• Commit search

  • Select GitHub Commit in the Type dropdown, as shown below.

  • Specify any text string contained in the message of the Commits you are searching for.

  • Click the Search button. The result will be shown on the RHS.

• Issue search

  • Select GitHub Issue in the Type dropdown, as shown below.

  • Add constraints to the Query, e.g. label:Improvement and state:open. For a full list of GitHub query filters, click here.

  • Click the Search button. The result will be shown on the RHS.

• Tag search

  • Select GitHub Tag in the Type dropdown, as shown below.

  • Specify any text string contained in the names of the Tags you are searching for.

  • Click the Search button. The result will be shown on the RHS.

Digital Thread Explorer

(1) See an overview of the Digital Thread Explorer - Digital Thread Explorer (DTE)

(2) See the tutorial for GitHub integration on Syndeia Web Dashboard - Part 6 - GitHub on Web Dashboard.

The Digital Thread Explorer will only display inter-model relations between GitHub artifacts and artifacts in other repositories/tools. Intra-model relations, i.e. relationships between GitHub artifacts, are not applicable.

Creating Relations

(1) See an overview of the Creating Relations - Creating Relations on the Web Dashboard

(2) See the tutorial for GitHub integration on Syndeia Web Dashboard - Part 6 - GitHub on Web Dashboard.