Skip to content

Commit

Permalink
Add full enterprise support and other minor fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
jwilander committed Sep 14, 2018
1 parent 8062403 commit 4053354
Show file tree
Hide file tree
Showing 8 changed files with 64 additions and 95 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@ A GitHub plugin for Mattermost. The plugin is currently in beta and does not yet

* __Daily reminders__ - the first time you log in to Mattermost each day, get a post letting you know what issues and pull requests need your attention
* __Notifications__ - get a direct message in Mattermost when omeone mentions you, requests your review, comments on or modifies one of your pull requests/issues, or assigns you on GitHub
* __Sidebar buttons__ - stay up-to-date with how many reviews, unread messaages and open pull requests you have with buttons in the Mattermost sidebar
* __Sidebar buttons__ - stay up-to-date with how many reviews, unread messaages, assignments and open pull requests you have with buttons in the Mattermost sidebar
* __Slash commands__ - interact with the GitHub plugin using the `/github` slash command
* __Subscribe to a respository__ - Use `/github subscribe` to subscribe a Mattermost channel to receive posts for new pull requests and/or issues in a GitHub repository
* __Get to do items__ - Use `/github todo` to get an ephemeral message with items to do in GitHub
* __Update settings__ - Use `/github settings` to update your settings for the plugin
* __And more!__ - Run `/github help` to see what else the slash command can do
* __Supports GitHub Enterprise__ - Works with SaaS and Enteprise versions of GitHub
* __Supports GitHub Enterprise__ - Works with SaaS and Enteprise versions of GitHub (Enterprise support added in version 0.6.0)

## Installation

__Requires Mattermost 5.2 or higher__

__If you're using GitHub enterprise, replace all GitHub links below with your GitHub Enterprise URL__
__If you're using GitHub Enterprise, replace all GitHub links below with your GitHub Enterprise URL__

1. Install the plugin
1. Download the latest version of the plugin from the GitHub releases page
Expand All @@ -41,6 +41,11 @@ __If you're using GitHub enterprise, replace all GitHub links below with your Gi
* Paste the webhook secret you copied before into the secret field
* Select the events: Issues, Issue comments, Pull requests, Pull request reviews, and Pull request review comments
3. Save the webhook
4. __Note for each organization you want to receive notifications for or subscribe to, you must create a webhook__
4. Configure a bot account
1. Create a new Mattermost user, through the regular UI or the CLI with the username "github"
2. Go to the System Console -> Plugins -> GitHub and select this user in the User setting
3. Save the settings
4. (Optional) Lock the plugin to a GitHub organization
* Go to System Console -> Plugins -> GitHub and set the GitHub Organization field to the name of your GitHub organization
5. Enable the plugin
Expand Down
8 changes: 4 additions & 4 deletions plugin.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"id": "github",
"name": "GitHub",
"description": "GitHub plugin for Mattermost.",
"version": "0.5.0",
"version": "0.6.0",
"backend": {
"executable": "server/plugin.exe"
},
Expand Down Expand Up @@ -34,7 +34,7 @@
"key": "Username",
"display_name": "User",
"type": "username",
"help_test": "Select the username of the user that the plugin will post with. This can be any user, the name and icon will be overridden when posting."
"help_text": "Select the username of the user that the plugin will post with. This can be any user, the name and icon will be overridden when posting."
},
{
"key": "EncryptionKey",
Expand All @@ -52,13 +52,13 @@
"key": "EnterpriseBaseURL",
"display_name": "Enterprise Base URL",
"type": "text",
"help_text": "(Optional) The base URL for using the plugin with a GitHub Enterprise installation."
"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."
"help_text": "(Optional) The upload URL for using the plugin with a GitHub Enterprise installation. This is often the same as your Base URL."
}
],
"footer": ""
Expand Down
87 changes: 11 additions & 76 deletions server/Gopkg.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 4053354

Please sign in to comment.