https://github.com/mattermost/mattermost-plugin-github
GitHub plugin for Mattermost
https://github.com/mattermost/mattermost-plugin-github
github github-integration hacktoberfest mattermost mattermost-plugin
Last synced: about 2 months ago
JSON representation
GitHub plugin for Mattermost
- Host: GitHub
- URL: https://github.com/mattermost/mattermost-plugin-github
- Owner: mattermost
- License: apache-2.0
- Created: 2018-02-26T15:12:08.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-08-06T17:19:16.000Z (2 months ago)
- Last Synced: 2025-08-06T19:20:27.417Z (2 months ago)
- Topics: github, github-integration, hacktoberfest, mattermost, mattermost-plugin
- Language: Go
- Homepage:
- Size: 6.46 MB
- Stars: 164
- Watchers: 31
- Forks: 158
- Open Issues: 81
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-list - mattermost-plugin-github
README
# Mattermost GitHub Plugin
[](https://circleci.com/gh/mattermost/mattermost-plugin-github)
[](https://codecov.io/gh/mattermost/mattermost-plugin-github)
[](https://github.com/mattermost/mattermost-plugin-github/releases/latest)
[](https://github.com/mattermost/mattermost-plugin-github/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22Up+For+Grabs%22+label%3A%22Help+Wanted%22)
A GitHub plugin for Mattermost. Supports GitHub SaaS and Enterprise versions.
See the [Mattermost Product Documentation](https://docs.mattermost.com/integrate/github-interoperability.html) for details on installing, configuring, enabling, and using this Mattermost integration.
## Development
This plugin contains both a server and web app portion. Read our documentation about the [Developer Workflow](https://developers.mattermost.com/integrate/plugins/developer-workflow/) and [Developer Setup](https://developers.mattermost.com/integrate/plugins/developer-setup/) for more information about developing and extending plugins.
### Releasing new versions
The version of a plugin is determined at compile time, automatically populating a `version` field in the [plugin manifest](plugin.json):
* If the current commit matches a tag, the version will match after stripping any leading `v`, e.g. `1.3.1`.
* Otherwise, the version will combine the nearest tag with `git rev-parse --short HEAD`, e.g. `1.3.1+d06e53e1`.
* If there is no version tag, an empty version will be combined with the short hash, e.g. `0.0.0+76081421`.
To disable this behaviour, manually populate and maintain the `version` field.
## How to Release
To trigger a release, follow these steps:
1. **For Patch Release:** Run the following command:
```
make patch
```
This will release a patch change.
2. **For Minor Release:** Run the following command:
```
make minor
```
This will release a minor change.
3. **For Major Release:** Run the following command:
```
make major
```
This will release a major change.
4. **For Patch Release Candidate (RC):** Run the following command:
```
make patch-rc
```
This will release a patch release candidate.
5. **For Minor Release Candidate (RC):** Run the following command:
```
make minor-rc
```
This will release a minor release candidate.
6. **For Major Release Candidate (RC):** Run the following command:
```
make major-rc
```
This will release a major release candidate.
### Playwright e2e tests
In order to get your environment set up to run [Playwright](https://playwright.dev) tests, please see the setup guide at [e2e/playwright](/e2e/playwright#readme).