Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: update deploy #272

Merged
merged 2 commits into from
Aug 19, 2024
Merged

doc: update deploy #272

merged 2 commits into from
Aug 19, 2024

Conversation

never112
Copy link
Contributor

No description provided.

@netlify Netlify
Copy link

netlify bot commented Aug 14, 2024 •
edited
Loading

✅ Deploy Preview for reviewbot-x ready!

Name Link
🔨 Latest commit 3e82905
🔍 Latest deploy log https://app.netlify.com/sites/reviewbot-x/deploys/66c2c46bc0ee0a00089422ae
😎 Deploy Preview https://deploy-preview-272--reviewbot-x.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@codecov Codecov
Copy link

codecov bot commented Aug 14, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.22%. Comparing base (b4e0a79) to head (3e82905).
Report is 4 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master     #272      +/-   ##
==========================================
+ Coverage   36.69%   37.22%   +0.53%     
==========================================
  Files          19       21       +2     
  Lines        1420     1585     +165     
==========================================
+ Hits          521      590      +69     
- Misses        858      931      +73     
- Partials       41       64      +23

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@qiniu-x qiniu-x
Copy link

qiniu-x bot commented Aug 14, 2024

[Git-flow] Hi @never112, There are some suggestions for your information:

Rebase suggestions

  • Following commits have duplicated messages

    update doc

    update doc

Which seems insignificant, recommend to use git rebase command to reorganize your PR.

For other git-flow instructions, recommend refer to these examples.

If you have any questions about this comment, feel free to raise an issue here:

wwcchh0123
wwcchh0123 reviewed Aug 15, 2024
View reviewed changes
docs/website/docs/getting-started/quickinstall.md Outdated


在集成部署之前，我们要先了解Reviewbot需要用到的一些参数变量。
| **名称** | **是否必须** | **途** | **获取方式** |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

途=> 用途

docs/website/docs/getting-started/quickinstall.md Outdated
| ssh_key | 必须 | 用来 拉取待检查代码 |本地生成ssh_key私钥,公钥添加到对应github账号 |
| access-token | 必须 | 用来触发使用相关githubapi |github账号setting中获取 |
| githubappid | 必须 | githubapp使用 |githubapp中获取 |
| githubappperm | 必须 | githhubapp使用 |创建githubapp是，设置 |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

”githhubapp使用“ 错误拼写

wwcchh0123
wwcchh0123 reviewed Aug 15, 2024
View reviewed changes
docs/website/docs/getting-started/quickinstall.md Outdated


### 安装Reviewbot服务
ReviewBot的安装是支持多种方式的，支持在物理机器上安装，虚拟机上安装，容器上安装，因为其中还会涉及到运行环境的安装，本文安装推荐的docker方式进行安装。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ReviewBot --> Reviewbot

docs/website/docs/getting-started/quickinstall.md Outdated
如果是通过githubapp的方式进行集成，需要将基本部署好的reviewbot服务，映射到外网ip或者域名上面，使github能访问到

### 创建GitHubApp
1. 创建GitHubApp，在Settings 》 Developer settings》 创建一个GitHubApp
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

》 可换成右箭头

docs/website/docs/getting-started/quickinstall.md Outdated
* Push
* Release
* Commit Comment
4.设置webook地址,将设置好的外网映射地址配置在githubapp的webhoo地址中
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

“4.” 后面缺少空格

docs/website/docs/getting-started/quickinstall.md Outdated
4.设置webook地址,将设置好的外网映射地址配置在githubapp的webhoo地址中

### 触发检查
1. 在GitHub中 提交PR， 就能触发RevieBot运行，看到本次合并的增量代码代码检查结果和合并建议
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

RevieBot 拼写

docs/website/docs/getting-started/quickinstall.md
其他：
| 名称 | 是否必须 | 用户| 获取方式 |
|:------:|:-------:|:------:|:------:|
| config | 非必须 | Reviewbot配置文件|在没有配置的情况下，会使用系统默认配置。配置方式参看 |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

参看地址是？

docs/website/docs/getting-started/quickinstall.md

#### 部署镜像
Docker 部署可以使用k8s进行部署，也可以在一台安装了docker的机器上进行部署。
- k8s部署（推荐）：
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

可以贴下参考部署的deploy/reviewbot.yaml

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

是的，更新了下

@never112 never112 force-pushed the quickstart1 branch 5 times, most recently from cef422c to d7f3cba Compare August 16, 2024 02:18
CarlJi
CarlJi reviewed Aug 19, 2024
View reviewed changes
docs/website/package.json Outdated Show resolved Hide resolved
@CarlJi CarlJi mentioned this pull request Aug 19, 2024
Closed
@CarlJi CarlJi merged commit 2598522 into qiniu:master Aug 19, 2024
7 checks passed
@never112 never112 deleted the quickstart1 branch August 19, 2024 09:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@CarlJi CarlJi CarlJi left review comments

@wwcchh0123 wwcchh0123 wwcchh0123 left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@never112 @CarlJi @wwcchh0123