Synchronization Gherkin Git - techtalk/SpecLog-Resources GitHub Wiki

Note: The GIT plugin currently only supports authentication with username/password over HTTP and HTTPS. SSH authentication is not currently supported.

The GIT plugin is a server plugin that clones and regularly fetches the configured git repository to a folder in the SpecLog Server. The linked Gherkin files are synchronised to the shared SpecLog repository from this folder based on the Gherkin file paths (relative to the git repository root) specified when linking a Gherkin file.

If you have configured SpecLog to synchronize the requirements with TFS work items, and the TFS project uses git source control, you have to configure this plugin as well in order to synchronize the Gherkin files. When linking the file, you have to chose Git repository as link type.

Configuring the plugin

Remote Location

Specify the URL of the git clone here, e.g. https://github.com/techtalk/SpecFlow.git.

Repository Path

Enter the path to the folder on the SpecLog server used by the plugin to check out the git repository. If the folder does not exist, the plugin will create it. If the folder already exists, ensure it is empty. The plugin will initialize this folder as a git repository.

Note: If a non-empty folder is specified, the following error is reported in the event log of the SpecLog Server:

[Error] The plugin 'SpecLog.GitPlugin' (repo: 0d1c903a-c4e3-4cdd-994d-1f5b5da0bdd7) failed to start: 
LibGit2Sharp.LibGit2SharpException: An error was raised by libgit2. Category = Invalid (Error).
'C:/speclog/git' exists and is not an empty directory

Branch

Specify the git remote branch name here, e.g. master.

Update Interval

The polling interval in minutes.

Git User

The user credential to be used to access the git repository (read-only), for non-public repositories.

To access git repositories in TFS, specify the user name in the form DOMAIN\user. If you do not specify a user name, the plugin attempts to access the TFS git repository using the SpecLog service user credentials.

Linking a Gherkin file

Click on the Link Gherkin File button to link a Gherkin file from a synchronized git repository. Select the Git repository as a provider and enter the file path of the Gherkin (.feature) file as the path. This path must be relative to the git repository root folder, e.g. src\Specs\MyFeature.feature. Both forward (/) and backslash (\) can be used in the path.

Note: While it is practical to take the file path from a local clone of the git repository, the plugin synchronizes the Gherkin files from the remote git repository, so you have to push changes in the Gherkin files in order to be visible in SpecLog.

After linking a gherkin file, you might need to wait a few minutes to see the linked result.

⚠️ **GitHub.com Fallback** ⚠️