English
Breadcrumbs

Git Store

Description

Connection to any platform that uses Git as version control

Type

git

Category

File

This store does not allow modification/deletion of existing files nor creating new files. With this store you can :

  • List Files within the store

  • Read the content of a file.

Configuration in States

The Git Store can be configured directly in the States interface via the Data Stores module. The following configuration mode is available:

Parameters

Name

Description

Mandatory

Default

Comment

Base URI

The HTTP(S) endpoint of the git repository. This expects the full endpoint:

http(s)://hostname(:port)/path/to/the/repo.git

Yes

—

e.g. https://github.com/depfac/df-local-deployment.git

Access Token

The access token used to authenticate to the Git Repository

Yes

—

Value is hidden

Branch

The branch of the project.

No

—

default value is “main”

Local Configuration

The local configuration is defined in a JSON file (stores.json) deployed directly on the Workers' server.

Name

Description

Type

Mandatory

Comment

BaseUri

The HTTP(S) endpoint of the git repository. This expects the full endpoint:

http(s)://hostname(:port)/path/to/the/repo.git

string

True


AccessToken

The access token used to connect to the GitLab repository

string

True


ProjectId

The branch of the project.

string

False

default value is “main”


JSON
{
    "Name": "git",
    "Type": "git",
    "HealthCheck": true,
    "Config": {
        "BaseUri": "https://github.com/depfac/df-local-deployment.git",
	 	"AccessToken": "xxx",
	 	"Branch": "main"
    }
}