From b5b0fe7129d878dc655fa0843f3ff9da3206f546 Mon Sep 17 00:00:00 2001 From: Felipe Martin Date: Thu, 16 Oct 2025 10:57:23 +0200 Subject: [PATCH] docs: add development and release docs --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 5a2b3fc..28dfa01 100644 --- a/README.md +++ b/README.md @@ -29,3 +29,16 @@ Choose to either censor the bad words with a character or reject the post with a ![Post rejected by the plugin](./images/post-rejected.gif) ![Post censored by the plugin](./images/post-censored.gif) + +## 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. \ No newline at end of file