Skip to content

Latest commit

 

History

History
70 lines (51 loc) · 3.15 KB

README.md

File metadata and controls

70 lines (51 loc) · 3.15 KB
Raw

Mattermost GitHub Plugin

Build Status Code Coverage Release HW

Maintainer: @hanzei Co-Maintainer: @mickmister

A GitHub plugin for Mattermost. Supports GitHub SaaS and Enterprise versions.

See the Mattermost Product Documentation 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 and 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:

  • 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 tests, please see the setup guide at e2e/playwright.