yproximite / pr-review-watcher
该包已被废弃,不再维护。没有建议的替代包。
一个开源工具,通过提醒开发者先检查明显问题,帮助代码审查者专注于重要内容。
v1.3.0
2015-09-01 16:22 UTC
Requires
- php: >=5.4.0
- deralex/yaml-config-service-provider: ~1.0
- doctrine/dbal: ~2.4
- guzzlehttp/guzzle: ~6.0
- silex/silex: ~1.3
- symfony/config: ~2.7
- symfony/form: ~2.7
- symfony/security: ~2.7
- symfony/security-csrf: ~2.7
- symfony/translation: ~2.7
- symfony/twig-bridge: ~2.7
- symfony/validator: ~2.7
- symfony/var-dumper: ~2.7
- symfony/yaml: ~2.7
- twig/twig: ~1.16
- dev-master
- v1.3.0
- v1.2.1
- v1.2.0
- v1.1.0
- v1.0.0
- dev-dependabot/composer/symfony/http-foundation-2.8.52
- dev-develop
- dev-feature/SameUser_DifferentBranch
- dev-feature/FA_icon
- dev-feature/fixTestOwnerToken
- dev-feature/configExample
- dev-feature/twig_error
- dev-feature/readme
- dev-feature/gitkeep
- dev-feature/reviewer
- dev-dev
- dev-test
This package is auto-updated.
Last update: 2020-09-09 10:12:54 UTC
README
原生 GitHub 支持
几个月前,GitHub 发布了一个新功能,支持拉取请求模板。你应该查看文档,看看是否符合你的需求。
此项目的目的是什么?
当创建新的拉取请求时,PR Review Watcher 会将你定义的检查列表作为拉取请求评论发布。
在拉取请求审查方面,该项目可以为你节省时间。
- 避免开发者可能犯的常见错误或陷阱
- 确保开发者已审查自己的代码
检查列表可以完全自定义。不需要 GitHub 凭证(只需令牌,这更安全)。
截图
如何安装项目
简单通过 composer 安装项目: composer require yproximite/pr-review-watcher
配置
安全
在文件 config/config.yml
中输入您希望的登录/SHA1密码(为了访问应用程序,请先运行 cp config/config.yml.example config/config.yml
)。
您可以在 SHA1 上生成您的 SHA1 密码。
凭证
首先,您需要一个 Github Token 以便发布评论。
查看 GitHub 文档 了解如何创建它。
项目
然后,您需要添加一个希望连接的项目。通过以下示例配置 GitHub webhook
- 在您的 GitHub 项目中,转到 设置 然后转到 webhooks & services。
- 输入应用程序的 URL +
/api
例如:https://[url_of_the_application]/api
,选择application/json
并仅选择事件 Pull Request。
您可以配置在何时发布评论
- 仅在针对
develop
分支 的拉取请求上发布清单:在配置的分支字段中输入 "develop"。 - 在所有分支上打开的拉取请求上发布清单:输入 "all"。
虚拟主机
nginx 示例
server {
listen 80;
server_name your.domain.name;
access_log /var/log/nginx/pr_watcher.access.log;
error_log /var/log/nginx/pr_watcher.error.log;
root path/of/project/web;
index index.php;
location ~ /\.ht {
deny all;
}
location ~ \.php$ {
fastcgi_index index.php;
fastcgi_split_path_info ^(.+\.php)(.*)$;
include fastcgi_params;
fastcgi_pass unix:/var/run/php5-fpm.sock;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
}
location / {
try_files $uri $uri/ /index.php?$query_string;
}
}