Git-bot-feedback

A rust library designed for CI tools to easily submit feedback on a git server.

Feedback on a git server using this library can be in the form of

• thread comments (for a PR or commit)
• setting output variables for other CI tools to consume
• append a summary comment to a CI workflow run's summary page
• mark the start and end of a group of log statements (in the CI workflow run's logs)
• files annotations
• Pull Request reviews

Optional Features

These cargo features are optional and disabled by default:

• file-changes: ability to list files changed with information like which lines have additions or which lines are shown in the diff.

TLS Backend

A TLS backend is explicitly not set by this crate. This is intended to allow library consumers to choose the TLS backend of their choice; see reqwest's features.

Supported git servers

This project is designed to easily add support for various git servers. The following is just a list of git servers that are planned (in order or priority).

• GitHub

• GitLab

  GitLab support requires GitLab v17.9 or newer and a GITLAB_TOKEN environment variable (an access token). See GitLab token permissions for the permissions each feature needs. GitLab does not support

  • posting thread comments for commits (push events)
  • output variables and step summaries (output variables are only logged)
  • hiding outdated PR review summary comments

• Gitea

  Gitea does not support

  • posting thread comments for commits (push events)

  Deleting a PR review's individual comments (see ReviewOptions::delete_review_comments) requires Gitea v1.25 or newer; older versions only resolve them.

  Only a repository admin can dismiss a PR review. If the token's user is not an admin, outdated reviews can only be deleted (see ReviewOptions::delete_review_comments).

• Forgejo

  Forgejo uses the Gitea implementation, so the same limitations apply. Forgejo support requires Forgejo Runner v7.0.0 or newer, which sets the FORGEJO_ACTIONS environment variable. The token is read from the GITEA_TOKEN environment variable, or the FORGEJO_TOKEN environment variable that the runner sets automatically. Forgejo also does not support resolving or deleting a PR review's individual comments.

• BitBucket

Optional support

Each supported implementation of the above git servers can be controlled via cargo features. They are enabled by default.

• github enables support of GitHub implementation
• gitea enables support of Gitea implementation
• gitlab enables support of GitLab implementation

LGPL license

This project is licensed under LGPL-3.0-or-later.

Since this library ultimately requires write access to users' projects (to allow posting comments), it could easily be modified with malicious intent.

By using the LGPL-3.0-or-later license, we can offer some assurance and help safeguard end-users' data/privacy because the following conditions must be met:

• the source code is publicly available
• any redistributed forms must state their modifications (if any)