chore: improve doc

This commit is contained in:
Pedro Lopez Mareque 2021-10-15 14:59:16 +02:00
parent 5baecfcec2
commit 61ca557faf
2 changed files with 9 additions and 9 deletions

View File

@ -24,15 +24,15 @@ type Integration struct {
type Options struct { type Options struct {
// BaseURL is the optional self-hosted github application url // BaseURL is the optional self-hosted github application url
BaseURL string `yaml:"base-url"` BaseURL string `yaml:"base-url"`
// Username is the username of the github user // Username is the mandatory username of the github user
Username string `yaml:"username"` Username string `yaml:"username"`
// Owner is the owner name of the repository for issues. // Owner is the mandatory owner name of the repository for issues.
Owner string `yaml:"owner"` Owner string `yaml:"owner"`
// Token is the token for github account. // Token is the mandatory token for github account.
Token string `yaml:"token"` Token string `yaml:"token"`
// ProjectName is the name of the repository. // ProjectName is the mandatory name of the repository.
ProjectName string `yaml:"project-name"` ProjectName string `yaml:"project-name"`
// IssueLabel is the label of the created issue type // IssueLabel is the mandatory label of the created issue type
IssueLabel string `yaml:"issue-label"` IssueLabel string `yaml:"issue-label"`
} }

View File

@ -21,13 +21,13 @@ type Integration struct {
type Options struct { type Options struct {
// BaseURL is the optional self-hosted gitlab application url // BaseURL is the optional self-hosted gitlab application url
BaseURL string `yaml:"base-url"` BaseURL string `yaml:"base-url"`
// Username is the username of the gitlab user // Username is the mandatory username of the gitlab user
Username string `yaml:"username"` Username string `yaml:"username"`
// Token is the token for gitlab account. // Token is the mandatory token for gitlab account.
Token string `yaml:"token"` Token string `yaml:"token"`
// ProjectName is the name of the repository. // ProjectName is the mandatory name of the repository.
ProjectName string `yaml:"project-name"` ProjectName string `yaml:"project-name"`
// IssueLabel is the label of the created issue type // IssueLabel is the mandatory label of the created issue type
IssueLabel string `yaml:"issue-label"` IssueLabel string `yaml:"issue-label"`
} }