Git Integration

To deploy your code, Artifakt integrates easily with your Git repository.

Each project is linked to a specific Git repository. If your application is composed of several Git repositories, you will need to create several projects on Artifakt or gather your source code within the same repository.

Git is the only version-control system supported by Artifakt.

Link a Git Repository to a Project

Third-party Git Providers

Artifakt integrates with GitHub, GitLab and Bitbucket. If your Git repository is hosted by one of these providers, then you can easily connect it to your Artifakt project from the project settings. Just go to Project β†’ Settings β†’ Environment, click on Link to a different repository and follow the steps (selecting the version manager, the Git repository and the branch to deploy by default).

Git provider selection

Artifakt never has access to your GitHub, GitLab, or Bitbucket credentials. The authentication step is managed by the Git provider.

In order to successfully connect Artifakt with your repository, you must ensure you have Admin rights at the repository level so that the Artifakt deploy key can be successfully installed. Bear in mind that you must also have sufficient organization rights to access the desired repository in the first place.

Please refer to the specific documentation of your git provider for more information regarding user access policies.

Self-hosted Git Providers

Artifakt can also integrate with any Git-based version-control system (via SSH or HTTPS) that you might host yourself.

If you want to use a private repository, you will need to allow Artifakt to clone your source code. Here are the steps to follow:

  1. You specify the URL of your Git repository

  2. We generate an SSH key pair

  3. You add our public key to your Git account (if your project uses private submodules, you must also add the public SSH key to those repositories)

  4. We then use that SSH key to clone your Git repository

Deploy key generated for self-hosted Git repositories

If you host your Git repositories and you use a firewall to filter SSH or HTTPS connections, remember to allow Artifakt's IP address (52.51.217.44). Otherwise, we won't be able to access your source code.

Update the connected repository in an existing project

You can modify a Git repository in any project at any time. Just go to Project β†’ Settings β†’ Environment and click on Link to a different repository.

Do not forget to change branch name on environments level if you have changed the Git repository of the project.

Manage Submodules

The submodule option is enabled by default during the build steps on Artifakt.

To include an outside repository as a subdirectory in your own repository, always configure it as a submodule. If you do not, it may work locally via cloning, but the sub-repository content will not be pushed to your Git provider, and it will not be available to your build on Artifakt.

If a submodule repository is public, you can use HTTPS format (for example, https://github.com/owner/project) to link it in your submodule configuration. If the repository is private, or if you prefer to use SSH format (for example, [email protected]:owner/project.git), you will need to add the deploy key provided by Artifakt to the repository.