[Compass-ci] Re: [PATCH compass-ci] doc: modify the tutorial

On Sat, Oct 31, 2020 at 03:27:32PM +0800, Li Ping wrote:

Signed-off-by: Li Ping 15396232681@163.com

doc/tutorial.md | 55 ++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 52 insertions(+), 3 deletions(-)

diff --git a/doc/tutorial.md b/doc/tutorial.md index 03f1342..932e927 100644 --- a/doc/tutorial.md +++ b/doc/tutorial.md @@ -46,15 +46,49 @@ Compass-CI 是一个可持续集成的软件平台。为开发者提供针对上

-## 使用 Compass-CI -> 当您注册之后，便可以编写 yaml 文件并通过我们的工具上传任务以进行自定义测试，测试功能将尽快上线。 +## 使用 Compass-CI# 前提条件

+- 申请账号

• 您可以通过向**compass-ci@139.com**发送邮件进行账号申请，邮件标题为"**apply account**"，在正文中提供**您向开源项目提交过的commit的url地址**(我们将根据此进行审查并决定是否发放账号)，并以附件方式添加**准备用来提交任务的个人电脑的公钥**。

139 => qq

上面的句子太长，分列为三个bullet会更清楚，不容易被用户遗漏。

• 发送邮件后，将收到一封回复邮件，邮件回复内容如下：

• Dear **,
  

• Thank you for joining us.
  

• You can use the following info to submit jobs:
  

• 1) setup default config
  

• run the following command to add the below setup to default config file
  

• mkdir -p ~/.config/compass-ci/defaults/
  

• cat >> ~/.config/compass-ci/defaults/.yaml <<-EOF
  

• my_uuid: 8b2ebcab-850e-4477-a942-660f52b45929
  

• lab: z9
  

• EOF
  

• 2) download lkp-tests and dependencies
  

• git clone https://gitee.com/wu_fengguang/lkp-tests.git
  

• cd lkp-tests
  

• make install
  

• source HOME/.bashrc && source HOME/.bash_profile
  

• 3) submit job
  

• reference: https://gitee.com/wu_fengguang/compass-ci/blob/master/doc/tutorial.md
  

• find how to write job yaml
  

• submit jobs/netperf.yaml
  

• regards
  

• compass-ci
  

以上内容可以全部删掉。

+- 您需要按照邮件中回复的步骤构建本地可以提交job的环境

• 注册自己的仓库

  如果您想在 `git push` 的时候, 自动触发测试, 那么需要把您的公开 git url 添加到如下仓库 [upstream-repos](https://gitee.com/wu_fengguang/upstream-repos)%E3%80%82

删掉上面的[upstream-repos](...) 保留下面的git clone. 这样更明确，可操作性更强。

-	git clone https://gitee.com/wu_fengguang/upstream-repos.git
less upstream-repos/README.md

@@ -140,6 +174,21 @@ job yaml 是测试描述和执行的基本单元，以[YAML](http://yaml.org/YAM

### 提交 borrow 任务

+borrow任务是指通过提交任务的方式申请环境，提交borrow任务的yaml文件请参考lkp-tests/jobs/borrow-1h.yaml。

+1. yaml文件配置说明：

• • 必填字段：

•  sshd:
  

• pub_key  \\将用户的公钥信息添加到job中
  

• my_email    \\ 配置用户邮箱地址
  

•  runtime    \\申请环境的使用时间 h/d/w
  

•  testbox    \\申请环境的规格
  

以上内容可以删掉。我们已经有borrow-1h.yaml. 在下面的submit命令行中指定testbox即可。

+--

• 执行命令```submit -m -c borrow-1h.yaml```，可以提交borrow任务并自动ssh连接到申请的环境当中。

submit 命令单列一行在下面, TAB缩进。

### 提交 bisect 任务

## 高级功能

2.23.0