Thread Comments¶
- class git_bot_feedback.ThreadCommentOptions¶
Options that control posting comments on a thread.
- comment¶
The comment to post.
- kind¶
The [
CommentKind] that describes the comment’s purpose.
- marker¶
A string used to mark/identify the thread’s comment as a comment submitted by this software.
User comments may be indistinguishable from bot/generated comments if this value is not unique enough.
If the git server employs Markdown syntax for comments, then it is recommended to set this to an HTML comment that is unique to your CI application:
<!-- my-cool-CI-app-name -->The default value for this is an HTML comment generated from this crate’s name and version along with the compile-tome’s datetime. For example:
<!-- git-bot-feedback/0.1.0/Jul-14-2025_17-00 -->
- no_lgtm¶
Disallow posting “Looks Good To Me” comments.
Setting this option to
truemay instigate the deletion of old bot comment(s), if any exist.
- policy¶
Controls posting comments on a thread that concerns a Pull Request or Push event.
Typically, this is only desirable for Pull Requests.
- class git_bot_feedback.CommentKind¶
An enumeration of possible type of comments being posted.
The default is [
CommentKind::Concerns].- Lgtm¶
A comment that indicates that the code is good to go.
- Concerns¶
A comment that indicates that there are concerns with the code.
- class git_bot_feedback.CommentPolicy¶
An enumeration of supported behaviors about posting comments.
See [
ThreadCommentOptions::policy](crate::ThreadCommentOptions::policy).- Anew¶
Always post a new comment. Old comments (from the same bot/author) will be deleted.
- Update¶
Update any existing comment or post a new one if no previous comments found.
Again, comments in scope are authored bny the same bot/author. If any more than 1 comment of the same bot/author is found, then all but the most recent comment will be deleted.