Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updates for GitHub and Zoom plugins #7148

Merged
merged 6 commits into from
May 30, 2024
Merged

Updates for GitHub and Zoom plugins #7148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a282fbe
update github docs for https://github.com/mattermost/mattermost-plugi…
mickmister May 20, 2024
020ed83
update zoom plugin docs for https://github.com/mattermost/mattermost-…
mickmister May 20, 2024
2606792
improvements to github plugin page
mickmister May 20, 2024
8afbd52
remove todo comment
mickmister May 20, 2024
d1d0809
Merge branch 'master' into github-zoom-plugin-docs-updates
cwarnermm May 27, 2024
c51a9f7
Merge branch 'master' into github-zoom-plugin-docs-updates
mickmister May 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 10 additions & 13 deletions source/integrate/github-interoperability.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ A Mattermost system admin must perform the following steps in GitHub.
- **Authorization callback URL**: ``https://YOUR-MATTERMOST-URL.COM/plugins/github/oauth/complete``, replacing ``https://YOUR-MATTERMOST-URL.COM`` with your Mattermost URL. This value must match the Mattermost server URL you use to log in.

3. Save your changes.
4. Select **Generate a new client secret**, and enter your GitHub password to continue.
5. Copy the **Client ID** and **Client Secret** in the resulting screen.
4. Select **Generate a new client secret**, and enter your GitHub password to continue.
5. Copy the **Client ID** and **Client Secret** in the resulting screen.
6. Generate a **Webhook Secret** and **At Rest Encryption Key** by selecting **Generate**.

Create a webhook in GitHub
Expand All @@ -49,10 +49,11 @@ A Mattermost system admin must perform the following steps in GitHub. Create a w
- **Secret**: The **Webhook Secret** value you copied earlier.

4. Under **Which events would you like to trigger this webhook?**, select **Let me select individual events**.
5. Select the following events:
5. Select the following events:

- Branch or Tag creation
- Branch or Tag deletion
- Releases
- Issue comments
- Issues
- Pull requests
Expand All @@ -73,10 +74,6 @@ A Mattermost system admin must perform the following steps in Mattermost.
- Convert the user account to a bot using :ref:`mmctl user convert <manage/mmctl-command-line-tool:mmctl user convert>`.
- Change the existing ``github`` username to something else. A new bot account called ``github`` is created the Mattermost server is restarted when the :ref:`enable bot account creation <configure/integrations-configuration-settings:enable bot account creation>` configuration setting is enabled.

.. note::

If you're using an older version of the GitHub integration (v0.9.0 and earlier), configure the username by going to **System Console > Plugins > GitHub**.

2. Install the GitHub integration from the in-product App Marketplace:

a. In Mattermost, from the Product menu |product-menu|, select **App Marketplace**.
Expand Down Expand Up @@ -108,10 +105,10 @@ We recommend updating this integration as new versions are released. Generally,
Usage
-----

Users who want to use GitHub interconnectivity must register an OAuth app in GitHub for Mattermost, and then connect a GitHub account to Mattermost.
Users who want to use GitHub interconnectivity must register an OAuth app in GitHub for Mattermost, and then connect a GitHub account to Mattermost.

Once connected, you'll receive direct messages from the GitHub bot in Mattermost when someone mentions you, requests a review, comments on, or modifies one of your pull requests/issues, or assigns you to an issue on GitHub.

Register an OAuth app in GitHub for Mattermost
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -131,7 +128,7 @@ Connect a GitHub account to Mattermost

2. Once connected, run the ``/github help`` slash command to see what you can do.

Get started
Get started
~~~~~~~~~~~

Here are some common slash commands you can get started with:
Expand All @@ -140,7 +137,7 @@ Run the ``/github subscriptions add`` slash command to subscribe a Mattermost ch

For example, to post notifications for issues, issue comments, and pull requests matching the label **Help Wanted** from the ``mattermost/mattermost-server`` GitHub repository, use: ``/github subscriptions add mattermost/mattermost-server --features issues,pulls,issue_comments,label:"Help Wanted"``. The following flags are supported:

- ``--features``: A comma-delimited list of one or more of: issues, pulls, pulls_merged, pulls_created, pushes, creates, deletes, issue_creations, issue_comments, pull_reviews, label:"labelname". Defaults to ``pulls,issues,creates,deletes``.
- ``--features``: A comma-delimited list of one or more of: issues, pulls, pulls_merged, pulls_created, pushes, creates, deletes, issue_creations, issue_comments, pull_reviews, releases, label:"labelname". Defaults to ``pulls,issues,creates,deletes``.
- ``--exclude-org-member``: The events triggered by organization members that won't be delivered. It will be locked to the organization configured and only works for users whose membership is public. Organization members and collaborators are not the same.
- ``--render-style``: Notifications are delivered in the specified style (for example, the body of a pull request will not be displayed). Supported values are ``collapsed``, ``skip-body``, or ``default`` (which is the same as omitting the flag).
- ``--exclude``: A comma-separated list of the repositories to exclude from getting the subscription notifications like ``mattermost/mattermost-server``. Only supported for subscriptions to an organization.
Expand All @@ -149,7 +146,7 @@ Run the ``/github todo`` slash command to get a message with items to do in GitH

Run the ``/github settings`` slash command to update your settings for notifications and daily reminders.

Run the ``/github setup`` slash command to configure the integration between GitHub and Mattermost. This command has the following subcommands:
Run the ``/github setup`` slash command to configure the integration between GitHub and Mattermost. You can run this command to run the entire setup process, or run one of the following subcommands to revisit a particular setup step:

- ``/github setup oauth``: Sets up the OAuth2 application in GitHub, establishing the necessary authorization connection between GitHub and Mattermost.
- ``/github setup webhook``: Creates a webhook from GitHub to Mattermost, allowing real-time notifications and updates from GitHub to be sent to Mattermost channels.
Expand Down Expand Up @@ -185,4 +182,4 @@ Customize

This integration contains both a server and web app portion. Visit the `Mattermost Developer Workflow <https://developers.mattermost.com/extend/plugins/developer-workflow/>`__ and `Mattermost Developer environment setup <https://developers.mattermost.com/extend/plugins/developer-setup/>`_ for information about developing, customizing, and extending Mattermost functionality.

In order to get your environment set up to run Playwright tests, please see the setup guide at `e2e/playwright <https://github.com/mattermost/mattermost-plugin-github/blob/master/e2e/playwright#readme>`_.
In order to get your environment set up to run Playwright tests, please see the setup guide at `e2e/playwright <https://github.com/mattermost/mattermost-plugin-github/blob/master/e2e/playwright#readme>`_.
Loading
Loading