评论

使用一体式 TUI 仪表板简化代码审查请求，提供需要审查的开放 PR 的概述！

快速开始

如果您想立即启动并运行评论，请运行：

export GITHUB_USER="your-github-username"
export GITHUB_TOKEN="your personal GitHub token used for interacting with the API"
export REVIEWS_GITHUB_REPOSITORY_CONFIGURATION="apoclyps/reviews"

pip install --upgrade reviews

reviews config --show

reviews metrics

reviews dashboard --no-reload

额外支持

查看配置

如果您希望随时查看评论使用的配置，可以使用以下命令显示所有配置（隐藏或显示秘密）：

reviews config --hide

reviews config --show

GitLab

如果您希望reviews与 Gitlab 一起使用，您需要像这样指定配置：product id:project name/repository并--provider=gitlab在运行时使用该标志reviews：

export GITLAB_USER=user
export GITLAB_TOKEN=token
export REVIEWS_GITLAB_REPOSITORY_CONFIGURATION="27629846:apoclyps/reviews"

reviews dashboard --provider=gitlab

开始本地开发

要在您的主机上构建和运行 CLI，您将需要 Python 3.9、pip 和 virtualenv 来构建和运行review. 如果您希望发布包含更改的 PR，请首先在 Github 上创建一个 fork 并克隆该代码。

$ gh repo clone apoclyps/reviews
$ cd reviews
$ python3 -m venv env
$ source env/bin/activate
(env)$ pip install -r requirements_dev.txt
(env)$ pip install -r requirements.txt
(env)$ python -m reviews dashboard

如果您希望在主机系统上保留评论的副本，您可以使用以下命令安装和运行它：

$ export REVIEWS_GITHUB_REPOSITORY_CONFIGURATION="apoclyps/reviews"
$ python -m venv env
$ source env/bin/activate
$ python -m pip install -e .
$ reviews -h

您可以在 Docker 中运行评论：

docker-compose build cli && docker-compose run --rm cli python -m reviews dashboard

要使用以下命令构建映像并使用所有必要的依赖项运行该映像：

$ docker-compose build cli
$ docker-compose run --rm cli python -m reviews dashboard

有关在 Docker 之外设置开发环境的说明，请查看wiki。

配置

评论支持 .ini 和 .env 文件。评论总是按以下顺序搜索配置：

• 环境变量;
• 存储库：ini 或 .env 文件；
• 配置路径
• 查看默认值

以下步骤用于使用.envor.ini文件提供配置。可以使用.env文件或通过环境变量指定的位置从模块/存储库（由 decouple 设置的默认位置）中读取配置，该位置指向.ini位于项目根目录中的文件或由PATH_TO_CONFIG.

使用.env存储库中的文件

cd /home/<your-user>/workspace/apoclyps/reviews
touch .env

echo "REVIEWS_REPOSITORY_CONFIGURATION=apoclyps/micropython-by-example" >> .env
python -m reviews config

使用.ini存储库中的文件

cd /home/<your-user>/workspace/apoclyps/reviews
touch settings.ini
echo "[settings]\nREVIEWS_REPOSITORY_CONFIGURATION=apoclyps/micropython-by-example" >> settings.ini

python -m reviews config

提供配置路径

如果您希望在运行应用程序时设置配置路径以使用inior.env文件，您可以通过提供配置路径来使用特定文件的配置，如下所示：

cd /home/apoclyps/
touch settings.ini
echo "[settings]\nREVIEWS_REPOSITORY_CONFIGURATION=apoclyps/micropython-by-example" >> settings.ini

cd /home/<your-user>/workspace/apoclyps/reviews
export REVIEWS_PATH_TO_CONFIG=/home/<your-user>/

python -m reviews config

如果在任何时候，您想确认您的配置反映了您提供的文件，您可以使用reviews configReviews 查看当前配置。

配置布局

评论提供了配置一些可选列的选项，以根据提供的配置显示/隐藏这些列。

例如，以下配置可用于显示或隐藏作者：

export REVIEWS_AUTHOR=false

测试

已包含一个测试套件以确保评论功能正常。

要使用详细输出运行整个测试套件，请运行以下命令：

$ pytest -vvv

或者，运行一组测试。

$ pytest -vvv tests/test_config.py

可以使用以下命令在 docker 中运行所有测试：

$ docker-compose build pytest && docker-compose run --rm pytest

掉毛

要运行单个 linting 步骤：

docker-compose build test
docker-compose run --rm --no-deps test isort .
docker-compose run --rm --no-deps test black --line-length 119 --check .
docker-compose run --rm --no-deps test mypy .
docker-compose run --rm --no-deps test flake8 .
docker-compose run --rm --no-deps test pylint --rcfile=.pylintrc reviews
docker-compose run --rm --no-deps test bandit reviews
docker-compose run --rm --no-deps test vulture --min-confidence 90 reviews
docker-compose run --rm --no-deps test codespell reviews
docker-compose run --rm --no-deps test find . -name '*.py' -exec pyupgrade {} +

您还可以设置pre-commit在提交阶段自动运行 linting 步骤，可以通过在项目根目录上运行以下命令来设置预提交管道：

pre-commit install

贡献

请阅读CONTRIBUTING.md了解我们的行为准则的详细信息，以及向我们提交拉取请求的流程。