- Get a personal token (scopes:
read_api) - Store it as a environment variable
export GITLAB_TOKEN=<your personal gitlab token>
$ npm install -g gitcg
$ gitcg COMMAND
running command...
$ gitcg --help [COMMAND]
USAGE
$ gitcg COMMAND
...By default gitcg reads all configurable options from config.json at the following location
Unix: ~/.config/gitcg
Windows: %LOCALAPPDATA%\gitcg
Can be overridden with XDG_CONFIG_HOME
Below are the available configurable options.
- service
- serviceUrl
- sections
- enableContributorsSection
- contributorsToExclude
- contributorTitle
- enableExternalIssuesTracker
- externalIssuesUrl
- externalIssuesProjects
| Name | Value |
|---|---|
| type | string |
| mandatory | true |
| supportedValues | gitlab |
Example
{
"service": "gitlab"
}| Name | Value |
|---|---|
| type | string |
| mandatory | true |
Example
{
"service": "gitlab",
"serviceUrl": "https://gitlab.com"
}| Name | Value |
|---|---|
| type | array |
| mandatory | false |
Example
{
"service": "gitlab",
"serviceUrl": "https://gitlab.com",
"sections": []
}| Name | Value |
|---|---|
| type | string |
| parent | sections |
| mandatory | true |
Example
{
"service": "gitlab",
"serviceUrl": "https://gitlab.com",
"sections": [
{
"title": ":star2: New Features",
"labels": ["feature"]
}
]
}| Name | Value |
|---|---|
| type | string |
| parent | sections |
| mandatory | true |
Example
{
"service": "gitlab",
"serviceUrl": "https://gitlab.com",
"sections": [
{
"title": ":star2: New Features",
"labels": ["feature"]
}
]
}| Name | Value |
|---|---|
| type | boolean |
| mandatory | false |
Example
{
"service": "gitlab",
"serviceUrl": "https://gitlab.com",
"enableContributorsSection": true,
"contributorTitle": ":heart: Contributors\nWe'd like to thank all the contributors who worked on this sprint!"
}| Name | Value |
|---|---|
| type | array |
| mandatory | false |
Example
{
"service": "gitlab",
"serviceUrl": "https://gitlab.com",
"enableContributorsSection": true,
"contributorsToExclude": ["user1", "user2"],
}| Name | Value |
|---|---|
| type | string |
| mandatory | false |
Example
{
"service": "gitlab",
"serviceUrl": "https://gitlab.com",
"enableContributorsSection": true,
"contributorTitle": ":heart: Contributors\nWe'd like to thank all the contributors who worked on this sprint!"
}| Name | Value |
|---|---|
| type | array |
| mandatory | false |
Example
{
"service": "gitlab",
"serviceUrl": "https://gitlab.com",
"enableExternalIssuesTracker": true
}| Name | Value |
|---|---|
| type | string |
| mandatory | false |
Example
{
"service": "gitlab",
"serviceUrl": "https://gitlab.com",
"enableExternalIssuesTracker": true,
"externalIssuesUrl": "https://youtrack.com/issue",
}| Name | Value |
|---|---|
| type | array |
| mandatory | false |
Example
{
"service": "gitlab",
"serviceUrl": "https://gitlab.com",
"enableExternalIssuesTracker": true,
"externalIssuesUrl": "https://youtrack.com/issue",
"externalIssuesProjects": ["PROJ1", "PROJ2"],
}