240db4e2a7
Some checks failed
Server CI / Postgres (shard 0) (push) Has been skipped
Server CI / Postgres (shard 3) (push) Has been skipped
BuildEnv Docker Image / build-image (push) Failing after 4s
BuildEnv Docker Image / build-image-fips (push) Failing after 4s
Migration Review & Release Notes / Generate migration review & release notes (push) Failing after 3s
Server CI / Build Environment (push) Failing after 3s
Server CI / Postgres (shard 1) (push) Has been skipped
Tools CI / check-style (mattermost-govet) (push) Failing after 4s
Server CI / Postgres (shard 2) (push) Has been skipped
Tools CI / check-style (mmgotool) (push) Failing after 3s
Server CI / Elasticsearch v8 Compatibility (push) Has been skipped
Server CI / OpenSearch v2 Compatibility (push) Has been skipped
Server CI / Postgres FIPS (shard 0) (push) Has been skipped
Tools CI / Test (mattermost-govet) (push) Failing after 3s
Server CI / Postgres FIPS (shard 1) (push) Has been skipped
Server CI / Postgres FIPS (shard 2) (push) Has been skipped
Tools CI / Test (mmgotool) (push) Failing after 3s
Server CI / Postgres FIPS (shard 3) (push) Has been skipped
Server CI / Run mmctl tests (push) Has been skipped
Server CI / Run mmctl tests (FIPS) (push) Has been skipped
Server CI / Merge Postgres Test Results (push) Has been skipped
Server CI / Merge Postgres FIPS Test Results (push) Has been skipped
Server CI / Check backport migrations (push) Has been skipped
Server CI / Check generated files (push) Has been skipped
Server CI / check-style (push) Has been skipped
Server CI / Vet API (push) Has been skipped
Server CI / Build mattermost server app (push) Has been skipped
Server CI / Server CI Complete (push) Failing after 2s
Server CI / Server CI Artifacts (push) Has been skipped
Server CI / Sentry Upload (push) Has been skipped
Server CI / Server CI Report (push) Failing after 5m1s
Server CI Nightly Race / Race Detector (push) Has been skipped
CodeQL / Analyze (go) (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
Webapp CI Cache Warm / Warm Webapp node_modules Cache (push) Has been cancelled
E2E CI Cache Warm / Warm E2E npm Registry Cache (push) Has been cancelled
API / build (push) Has been cancelled
Web App CI / check-types (push) Has been cancelled
Web App CI / check-lint (push) Has been cancelled
Web App CI / check-i18n (push) Has been cancelled
Web App CI / check-external-links (push) Has been cancelled
Web App CI / test (platform) (push) Has been cancelled
Web App CI / test (mattermost-redux) (push) Has been cancelled
Web App CI / test (channels shard 1/4) (push) Has been cancelled
Web App CI / test (channels shard 2/4) (push) Has been cancelled
Web App CI / test (channels shard 3/4) (push) Has been cancelled
Web App CI / test (channels shard 4/4) (push) Has been cancelled
Web App CI / upload-coverage (push) Has been cancelled
Web App CI / build (push) Has been cancelled
YAML Lint / yamllint (push) Has been cancelled
Push mirrored docker images / cd/Push mirrored docker images (push) Has been cancelled
docs-cd / Build and deploy docs (push) Has been cancelled
Docs CI / build (push) Has been cancelled
E2E Cache Warm: Cypress deps / Warm Cypress deps cache (push) Has been cancelled
Scorecards supply-chain security / Scorecard analysis (push) Has been cancelled
Server CI Weekly / Postgres FIPS (push) Has been skipped
Server CI Weekly / Run mmctl tests (FIPS) (push) Has been skipped
Server CI Weekly / Postgres with binary parameters (push) Has been skipped
Server CI Weekly / Build Environment (push) Failing after 1s
Server CI Cache Warm / Warm Go Module and Build Cache (push) Failing after 2s
Server CI Nightly Race / Build Environment (push) Failing after 1s
82 lines
4.4 KiB
Markdown
82 lines
4.4 KiB
Markdown
---
|
|
title: "Process to include plugin on community"
|
|
sidebar_position: 120
|
|
---
|
|
|
|
Getting your plugin onto our Community server https://community.mattermost.com is a valuable source of feedback. Whether you're a [core committer](/developers/contribute/more-info/getting-started/core-committers) or anyone from the community, we want you to get feedback to improve your plugin.
|
|
|
|
However we must ensure that our Community server remains stable for everyone. This document outlines the process of getting your plugin onto the Community server and some of these steps are required to get your plugin into the [Marketplace](/developers/integrate/plugins/community-plugin-marketplace).
|
|
|
|
When you're ready to begin this process for your plugin, ask in the [Toolkit channel](https://community.mattermost.com/core/channels/developer-toolkit) on the Community server. The PM, or someone else from the Integrations team, will help you start the process.
|
|
|
|
## Checklist
|
|
|
|
### Deploy to ci-extensions
|
|
|
|
- [Basic Code Review](#basic-code-review) passed
|
|
- [CI system setup](#ci-system-setup) to build master
|
|
- Has a [compatible licence](#compatible-licence).
|
|
|
|
### Deploy to ci-extensions-release
|
|
|
|
- Complete code review by two core committers. One focused on security.
|
|
- [QA pass](#qa-pass)
|
|
- [PM/UX review](#pmux-review)
|
|
- Release created and [CI system setup](#ci-system-setup) to build releases
|
|
|
|
### Deploy to community.mattermost.com
|
|
|
|
- QA pass on ci-extensions-release of the release to deploy.
|
|
|
|
## Step definitions
|
|
|
|
### Basic code review
|
|
|
|
Basic code review of an experimental plugin involves a quick review by a [core committer](/developers/contribute/more-info/getting-started/core-committers) to verify that the plugin does what it says it does and to provide any guidance and feedback. To make it easier to provide feedback, a PR can be made that contains all the code of the plugin that isn't the boilerplate from mattermost-plugin-starter-template.
|
|
|
|
- When you are ready for your plugin to start this process, post an introduction in the [Integrations and Apps channel](https://community.mattermost.com/core/channels/integrations) on the Community server. Here is [an example](https://community.mattermost.com/core/pl/6dci1ssexjrh9rmdzt4pdpb9zy).
|
|
|
|
### CI system setup
|
|
|
|
Setting up the CI system for your plugin will allow continuous testing of your master branch and releases on our testing servers. Master branch testing is done on https://ci-extensions.azure.k8s.mattermost.com/ and release testing is done on https://ci-extensions-release.azure.k8s.mattermost.com/.
|
|
|
|
In order to set this up, the plugin creator needs to provide a URL that hosts latest master build, which we can pull on a nightly basis. Once that exists you can make a request in the [Integrations and Apps](https://community.mattermost.com/core/channels/integrations) channel.
|
|
|
|
### Compatible licence
|
|
|
|
Recommended licences:
|
|
|
|
- Apache Licence 2.0
|
|
- MIT
|
|
- BSD 2-clause
|
|
- BSD 3-clause
|
|
|
|
[More info](https://www.apache.org/legal/resolved.html#category-a)
|
|
|
|
### Complete code review
|
|
|
|
A more thorough code review is performed before allowing a plugin on `ci-extensions-release`. This review works the same as the basic code review, but the developers performing the review will be more thorough. If the developer that performed the first review is available, they should be one of the reviewers. Another of the reviewers should focus their review on any security implications of the plugin.
|
|
|
|
### QA pass
|
|
|
|
QA pass involves getting a member of our QA team to take a look and verify the functionality advertised by your plugin.
|
|
|
|
Steps involved:
|
|
|
|
- Ensure all setup documentation needed is clear and can be successfully followed.
|
|
- Dedicated instance or test account to access and test the third-party service, if applicable.
|
|
- Functional testing has been done to ensure the integration works as expected.
|
|
- For plugins owned by Mattermost, release testing is added to cover the main functionality of the plugin.
|
|
|
|
### PM/UX review
|
|
|
|
A PM/UX pass involves getting PM support in ironing out any user experience or UI issues with the plugin.
|
|
|
|
Steps involved:
|
|
|
|
- Create a one paragraph summary of the integration.
|
|
- Document the main use cases in bullet form.
|
|
- Review the primary use cases and run through them to ensure they are complete, clear, and functional.
|
|
- Ensure there is documentation to support the plugin. This may include having sufficient helper text in the plugin.
|
|
- Consider if communication to other teams or users is required as part of the rollout to our Community server.
|