https://github.com/parabolinc/parabol-mattermost-plugin
Parabol plugin for Mattermost
https://github.com/parabolinc/parabol-mattermost-plugin
mattermost mattermost-plugin retrospective
Last synced: 5 months ago
JSON representation
Parabol plugin for Mattermost
- Host: GitHub
- URL: https://github.com/parabolinc/parabol-mattermost-plugin
- Owner: ParabolInc
- License: apache-2.0
- Created: 2024-09-16T13:50:56.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-05T18:09:22.000Z (9 months ago)
- Last Synced: 2025-02-05T19:32:39.481Z (9 months ago)
- Topics: mattermost, mattermost-plugin, retrospective
- Language: Go
- Homepage: https://www.parabol.co
- Size: 688 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Parabol Mattermost Plugin
Manage your Parabol activities, add reflections or tasks and invite your team directly from Mattermost.
Right now this plugin can only be used with self-hosted versions of both Parabol and Mattermost.
Both need to be configured to use the same IdP and must not accept other login methods.
## Requirements
- Mattermost version 10.1 or later
- Parabol version 8.4.0 or later
- `SiteURL` If the `SiteURL` is not set correctly, some functions like notifications will not work.
- SSO identity provider for both Mattermost and Parabol
## Development
- Create a `.env` file in the root of the project:
```bash
cp .env.example .env
```
- Start up a Mattermost development server
```bash
make start-server
```
go to http://localhost:8065 and do the initial setup. Create a [personal access token](https://docs.mattermost.com/developer/personal-access-tokens.html)
and set the environment variable `MM_ADMIN_TOKEN` to the token value.
- Run
```
make watch
```
to start the plugin in development mode. This will watch for webapp changes and automatically rebuild the plugin.
- Configure the plugin in mattermost, go to System Console -> Plugins -> Parabol and enter
- Parabol URL: http://host.docker.internal:3000
- Parabol API Token: get this from MATTERMOST_SECRET environment of your Parabol instance
### 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.