mattermost-plugin-cleanup-c.../README.md
Felipe M. 2ecbd2442d
Some checks failed
ci / test (push) Failing after 1m5s
ci / lint (push) Failing after 1m6s
ci / build (push) Failing after 1m6s
release / release (push) Failing after 50s
Add Mattermost plugin for system-admin channel cleanup.
Provide a channel header menu action and /cleanup-channel slash command so system administrators can remove all messages from a channel, with admin checks enforced on both the web app and server. Configure CI and release workflows for the Forgejo runner and signed plugin bundles.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-07-25 18:46:39 +02:00

33 lines
1.1 KiB
Markdown

# Cleanup Channel
A Mattermost plugin that lets system administrators remove all messages from a channel.
## Features
- **Channel menu action**: "Remove all messages" appears in the channel header menu for system administrators only.
- **Slash command**: `/cleanup-channel` removes all messages from the current channel (system administrators only).
- **Defense in depth**: Both the web app and server verify that the user is a system administrator before performing any cleanup.
## Build
```bash
make dist
```
The plugin bundle is written to `dist/com.fmartingr.mattermost-plugin-cleanup-channel-*.tar.gz`.
## Usage
1. Upload and enable the plugin in **System Console → Plugins → Plugin Management**.
2. As a system administrator, open a channel and use the channel header menu (**⋯**) → **Remove all messages**.
3. Or run `/cleanup-channel` in the channel you want to clean up.
Both actions ask for confirmation before deleting messages.
## Development
```bash
make deploy
```
Requires a local Mattermost server configured for plugin development. See the [Mattermost plugin developer guide](https://developers.mattermost.com/integrate/plugins/).