ccollab admin config remote-system-integration create

Applies to Collaborator 13.4, last modified on January 18, 2021

Description

The ccollab admin config remote-system-integration create command creates a new configuration of remote system integration.

Command Line Syntax

ccollab [global-options] admin config remote-system-integration create <remote-system-type> <remote-system-title> <remote-system-config>

Command Options

Option

Required?

Description

<remote-system-type>

Yes

Type of remote system integration to create. Possible values: jira, github

<remote-system-title>

Yes

New name of remote system configuration.

<remote-system-config>

Yes

A string with a JSON object that specifies new configuration for the remote system integration.

For Bitbucket integration the JSON object must have the following fields:

'{"repoURI":"string", "apiToken":"string", "branch":"string", "branchToIgnorePushes":"string", "autoMerge":"string", "autoClose":"string"}'

The "repoURI" and "apiToken" fields are required. Other fields can be omitted.

For GitHub integration the JSON object must have the following fields:

'{"repoURI":"string", "apiToken":"string", "branch":"string", "apiURI":"string", "branchToIgnorePushes":"string", "pullingInterval":"string", "autoMerge":"string", "autoClose":"string"}'

The "repoURI" and "apiToken" fields are required. Other fields can be omitted.

For JIRA integration the JSON object must have the following fields:

'{"url":"string", "username":"string", "password":"string", "updateReviewPhase":boolean, "updateReviewParticipants":boolean, "projects":"string", "issueType":"string"}'

The "url", "username" and "password" fields are required. Other fields can be omitted.

Configuration fields are analogous to those displayed in Collaborator's user interface.

Example

The following command line adds a new Bitbucket integration:

ccollab admin config remote-system-integration create bitbucket "A New Bitbucket" '{"repoURI":"https://bitbucket.org/user/repo.git", "apiToken":"12345abcdefgh098765xyz", "branch":"foo,bar,baz", "branchToIgnorePushes":"", "autoMerge":"Merge Pull Request and Delete Its Branch", "autoClose":"Do nothing"}'

The following command line adds a new GitHub integration:

ccollab admin config remote-system-integration create github "A New GitHub" '{"repoURI":"https://github.com/user/repo.git", "apiToken":"12345abcdefgh098765xyz", "branch":"foo,bar,baz", "apiURI":"", "branchToIgnorePushes":"","pullingInterval":"15","autoMerge":"Merge Pull Request and Delete Its Branch","autoClose":"Do nothing"}'

The following command line adds a new JIRA integration:

ccollab admin config remote-system-integration create jira "A New JIRA" '{"url":"http://jira.example.com", "username":"admin", "password":"admin", "updateReviewPhase":true, "updateReviewParticipants":true, "projects":"PROJECT1, PROJECT2", "issueType":"Bug"}'

See Also

ccollab admin config remote-system-integration
Remote System Integrations

Highlight search results