forked from mattermost/mattermost-plugin-github
-
Notifications
You must be signed in to change notification settings - Fork 1
/
plugin.json
134 lines (134 loc) · 6.64 KB
/
plugin.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
{
"id": "github",
"name": "GitHub",
"description": "GitHub plugin for Mattermost.",
"homepage_url": "https://github.com/mattermost/mattermost-plugin-github",
"support_url": "https://github.com/mattermost/mattermost-plugin-github/issues",
"icon_path": "assets/icon.svg",
"min_server_version": "7.1.0",
"server": {
"executables": {
"linux-amd64": "server/dist/plugin-linux-amd64",
"linux-arm64": "server/dist/plugin-linux-arm64",
"darwin-amd64": "server/dist/plugin-darwin-amd64",
"darwin-arm64": "server/dist/plugin-darwin-arm64",
"windows-amd64": "server/dist/plugin-windows-amd64.exe"
}
},
"webapp": {
"bundle_path": "webapp/dist/main.js"
},
"settings_schema": {
"header": "The GitHub plugin for Mattermost allows users to subscribe to notifications, stay up-to-date with reviews, see the status of pull requests at a glance, and other common GitHub actions - directly from Mattermost. \n \n Instructions for setup are [available here](https://www.mattermost.com/pl/default-github-plugin#configuration).",
"settings": [
{
"key": "UsePreregisteredApplication",
"display_name": "Use Preregistered OAuth Application:",
"type": "bool",
"help_text": "Set to false if using GitHub Enterprise. When true, instructs the plugin to use the preregistered GitHub OAuth application - application registration steps can be skipped. Requires [Chimera Proxy](https://github.com/mattermost/chimera) URL to be configured for the server. Cannot be used with GitHub enterprise.",
"default": false,
"hosting": "cloud"
},
{
"key": "GitHubOAuthClientID",
"display_name": "GitHub OAuth Client ID:",
"type": "text",
"help_text": "The client ID for the OAuth app registered with GitHub."
},
{
"key": "GitHubOAuthClientSecret",
"display_name": "GitHub OAuth Client Secret:",
"type": "text",
"help_text": "The client secret for the OAuth app registered with GitHub.",
"secret": true
},
{
"key": "WebhookSecret",
"display_name": "Webhook Secret:",
"type": "generated",
"help_text": "The webhook secret set in GitHub.",
"secret": true
},
{
"key": "EncryptionKey",
"display_name": "At Rest Encryption Key:",
"type": "generated",
"help_text": "The AES encryption key used to encrypt stored access tokens.",
"secret": true
},
{
"key": "GithubOrg",
"display_name": "GitHub Organizations:",
"type": "text",
"help_text": "(Optional) Set to lock the plugin to one or more GitHub organizations. Provide multiple orgs using a comma-separated list."
},
{
"key": "EnterpriseBaseURL",
"display_name": "Enterprise Base URL:",
"type": "text",
"help_text": "(Optional) The base URL for using the plugin with a GitHub Enterprise installation. Example: https://github.example.com"
},
{
"key": "EnterpriseUploadURL",
"display_name": "Enterprise Upload URL:",
"type": "text",
"help_text": "(Optional) The upload URL for using the plugin with a GitHub Enterprise installation. This is often the same as your Base URL."
},
{
"key": "EnableLeftSidebar",
"display_name": "Display Notification Counters in Left Sidebar",
"type": "bool",
"help_text": "When false, the counters showing the user how many open/assigned issues they have in Github will not be shown in the Left Hand Sidebar on desktop browsers.",
"default": true
},
{
"key": "EnablePrivateRepo",
"display_name": "Enable Private Repositories:",
"type": "bool",
"help_text": "(Optional) Allow the plugin to work with private repositories. When enabled, existing users must reconnect their accounts to gain access to private repositories. Affected users will be notified by the plugin once private repositories are enabled."
},
{
"key": "ConnectToPrivateByDefault",
"display_name": "Connect to private Repositories by default:",
"type": "bool",
"help_text": "(Optional) When enabled, /github connect command will let users connect to their github account and gain access to private repositories without explicitly mentioning private."
},
{
"key": "EnableCodePreview",
"display_name": "Enable Code Previews:",
"type": "dropdown",
"help_text": "Allow the plugin to expand permalinks to GitHub files with an actual preview of the linked file.",
"default": "public",
"options": [
{
"display_name": "Enable for public repositories",
"value": "public"
},
{
"display_name": "Enable for public and private repositories. This might leak confidential code into public channels",
"value": "privateAndPublic"
},
{
"display_name": "Disable",
"value": "disable"
}
]
},
{
"key": "EnableWebhookEventLogging",
"display_name": "Enable Webhook Event Logging:",
"type": "bool",
"help_text": "Allow the plugin to log the webhook event. The log level needs to be set to DEBUG.",
"default": false
},
{
"key": "ShowAuthorInCommitNotification",
"display_name": "Show Author in commit notification:",
"type": "bool",
"help_text": "In 'Pushes' event notification, show commit author instead of commit committer.",
"default": false
}
],
"footer": "* To report an issue, make a suggestion or a contribution, [check the repository](https://github.com/mattermost/mattermost-plugin-github)."
}
}