Source Code
Guide on working with source code and Git repositories in Ketryx
1. Introduction
1.1. Purpose
This guide provides an introduction to working with Git repositories in Ketryx. The focus is on outlining the process of setting up repositories. This guide will walk you through the steps required to establish a connection between Git and Ketryx.
1.2. Tools
Tools used to develop and release a product with Ketryx Lifecycle Management are provided in MAN-01 Ketryx Lifecycle Management. The release process is described in detail in MAN-02 Software Release Process, while setting up code repositories is described in MAN-03 Supply Chain Management.
2. Supported platforms
Ketryx supports Git repository data fetching for repositories hosted on GitHub, Bitbucket, and GitLab. If you need support for other platforms like Azure DevOps, etc., please contact our support.
3. Adding your repository to Ketryx
On the project creation, or for existing projects on their settings page, you can add a repository:
To pull the Code Change Reviews (CCR)
For SOUP dependency analysis
The URL of the repository is required, and you can also add authentication information for the repository. This is required for private repositories, and for public repositories if you want to fetch CCR data.
Additionally, the analyzed branch can be set, which is the branch that is used for SOUP dependency analysis, CCR data fetching or configuration items syncing. The default is main or, in lieu of that, master.
Instead of a branch, you can also set a tag, which will be used for SOUP dependency analysis, CCR data fetching or configuration items syncing. This is useful if you want to analyze a specific release version, e.g., refs/tags/v1.0.0.
You can also define a release ref pattern. The naming pattern used to detect release branches or tags. These can be version-specific. Use # as a SemVer-compatible version placeholder. For example, release/# will match release/3.2.1, release/3.2, or release/3 (considered in this order of precedence) for a version with version number 3.2.1. The default is refs/tags/#.
3.1. Private repositories
For private repositories, you need to add authentication information. This is done on the project settings page, where you can enable repository authentication. You can set a username and password, which will be used to authenticate with the repository.
For more information about specific hosting services, see the guides for Bitbucket, GitHub, and GitLab.
4. Related features and guides
Please see MAN-03 Supply Chain Management: Software Dependencies for more information on how to use the SOUP dependency analysis feature.
Please see MAN-09 Git-Based Configuration Items for more information on how to use Git-based configurations items.
Please see the guide on Code Change Reviews using Ketryx for more information on how to use that feature, which is supported for GitHub and Bitbucket.
Please see the documentation of the builds API and how to set up GitHub Actions for integration with CI/CD systems.
Last updated