Implements plugin to notify new release #18
Conversation
| [package] | ||
| name = "sleppa_notifier" | ||
| description = "Send a pos to a collaboration platform when a new release is published." | ||
| version = "0.1.0" |
There was a problem hiding this comment.
Perhaps better to set the version to 0.0.0-semver. However, this means we shall change local references in Cargo.toml files accordingly, like:
sleppa_notifier = { path = "../sleppa_other_package }| @@ -0,0 +1,7 @@ | |||
| /// This module regroups all the constants used in the `sleppa_notifier` crate. | |||
There was a problem hiding this comment.
Constants declaration module.
| #[derive(thiserror::Error, Debug)] | ||
| pub enum NotifierError { | ||
| /// No match found when capturing the number with the regex | ||
| #[error("An error occured: {0}.")] |
There was a problem hiding this comment.
Note really an explanatory message. Can you be more precise about the nature of this error?
| InvalidContext(String), | ||
| } | ||
|
|
||
| /// Definition of the commit analyzer result |
|
|
||
| /// Defines the CreatePost object defined by Mattermost's API | ||
| #[derive(Debug, Serialize, Deserialize)] | ||
| pub struct CreatePost { |
There was a problem hiding this comment.
No verb in data structure. This is not an intention or an action.
| /// to login into the instance, an HTTP client and the token to authenticate to. | ||
| /// The authentication_token is required. A session token should be retrieved if the authentication is made by | ||
| /// an user login. The [login] method does this process. | ||
| pub struct Mattermost { |
There was a problem hiding this comment.
This is not a Mattermost instance. This does not mean anything. This is more a MM client
| } | ||
| } | ||
|
|
||
| impl Mattermost { |
There was a problem hiding this comment.
MattermostClient will be a better name
| Ok(()) | ||
| } | ||
|
|
||
| /// Posts a new message on a Mattermost intance. |
There was a problem hiding this comment.
Posts a new message on a Mattermost channel.
|
|
||
| /// Posts a new message on a Mattermost intance. | ||
| /// | ||
| /// This method posts a given [Post] on the specified Mattermost instance. |
There was a problem hiding this comment.
You do not publish on an 'instance'. The comment is not correct.
Description
This pull request implements a plugin to notify a new release on a collaboration platform such as Mattermost, Zulip or Slack.
The plugin uses the context to access the new tag of the repository.
The plugin is generic over the platform and provides a trait
Notifywith an associated methodnotify_releaseto publish the post.The posted message looks like :
New release v3.2.1 !wherev3.2.1is the new tag.At first, the plugin works with Mattermost only by providing a module named
mattermost.To post on this platform, the module should access a user with
create_postpersmission in the specified channel.The channel to post to is defined by its
channel_idwhich can be retrieved with the team name and GUID :https://your-mattermost-url.com/api/v4/teamshttps://your-mattermost-url.com/api/v4/teams/{team_id}/channels/name/{channel_name}More API's information on :
Related issues
closes #17
How has this been tested?
The crates contain unit tests in the file
tests.rs.Test configuration:
Rust cargo testChecklist: