Skip to content

Commit 8f721eb

Browse files
committed
docs: 修改README
1 parent 8e5904f commit 8f721eb

2 files changed

Lines changed: 14 additions & 22 deletions

File tree

README-zh-cn.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ X-Developer Analysis Action 在代码提交后,自动触发 X-Developer 团队
1717

1818
访问 [X-Developer Site](https://x-developer.cn) 网站免费注册。
1919

20-
注册完成后,[配置客户端页面](https://x-developer.cn/projects/client) 查看您的 `APPID` `APPKEY`
20+
注册完成后,可在 [API](https://x-developer.cn/accounts/api) 页面查看您的 `APPID` `APPKEY`
2121

2222
### 创建您的团队
2323

@@ -26,12 +26,14 @@ X-Developer Analysis Action 在代码提交后,自动触发 X-Developer 团队
2626

2727
> 此 GitHub Action 面向任何用户均免费。
2828
29-
创建团队完成后,即可在 [数据源配置页面](https://x-developer.cn/projects/sources) 查看对应的 `TEAMID`
29+
创建团队完成后,即可在 [API](https://x-developer.cn/accounts/api) 页面查看对应的 `TEAMID`
3030

3131
### 创建 GitHub Secrets
3232

3333
进入仓库 setting -> secrets, 创建 `APPID` `APPKEY` `TEAMID` 并配置对应的值。
3434

35+
> 如果您使用 GitHub 组织,可以将 `APPID` `APPKEY` 配置在您的组织 `secrets` ,即可被所有仓库使用,以简化操作步骤。
36+
3537
### 配置 Action
3638

3739
```
@@ -40,29 +42,23 @@ name: X-Developer Analysis Action
4042
on:
4143
push:
4244
branches: [ master ]
43-
pull_request:
44-
branches: [ master ]
4545
4646
jobs:
4747
build:
4848
runs-on: ubuntu-latest
4949
5050
steps:
51-
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
5251
- uses: actions/checkout@v1
5352
54-
# Setup Python Environment
5553
- name: Setup Python 2.7
5654
uses: actions/setup-python@v1
5755
with:
58-
python-version: 2.7.17
56+
python-version: 2.7.18
5957
60-
# Install X-Developer Client
61-
- name: Install X-Developer Command Line Client
58+
- name: Install X-Developer client
6259
run: pip install xdclient
6360
64-
# Runs a set of commands using the runners shell
65-
- name: Run analysis
61+
- name: Run X-Developer analysis
6662
env:
6763
APPID: ${{ secrets.APPID }}
6864
APPKEY: ${{ secrets.APPKEY }}

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This Action authenticate with X-Developer server by GitHub secrets `APPID` and `
1313

1414
Enter [X-Developer Site](https://x-developer.cn) and register an account for free.
1515

16-
Get your `APPID` `APPKEY` from [config your client page](https://x-developer.cn/projects/client).
16+
Get your `APPID` `APPKEY` from [API](https://x-developer.cn/accounts/api) page.
1717

1818
### Create Your Team
1919

@@ -22,12 +22,14 @@ Get your `APPID` `APPKEY` from [config your client page](https://x-developer.cn/
2222

2323
> This GitHub Action is free for all the users.
2424
25-
Once you created a project, check your `TEAMID` from [data source page](https://x-developer.cn/projects/sources).
25+
Once you created a project, check your `TEAMID` from [API](https://x-developer.cn/accounts/api) page.
2626

2727
### Create GitHub Secrets
2828

2929
Enter your repository setting -> secrets, create `APPID` `APPKEY` `TEAMID` and specify the values.
3030

31+
> You could create `APPID` and `APPKEY` in organization `secrets` if you're working in an organization.
32+
3133
### Config Action
3234

3335
```
@@ -36,29 +38,23 @@ name: X-Developer Analysis Action
3638
on:
3739
push:
3840
branches: [ master ]
39-
pull_request:
40-
branches: [ master ]
4141
4242
jobs:
4343
build:
4444
runs-on: ubuntu-latest
4545
4646
steps:
47-
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
4847
- uses: actions/checkout@v1
4948
50-
# Setup Python Environment
5149
- name: Setup Python 2.7
5250
uses: actions/setup-python@v1
5351
with:
54-
python-version: 2.7.17
52+
python-version: 2.7.18
5553
56-
# Install X-Developer Client
57-
- name: Install X-Developer Command Line Client
54+
- name: Install X-Developer client
5855
run: pip install xdclient
5956
60-
# Runs a set of commands using the runners shell
61-
- name: Run analysis
57+
- name: Run X-Developer analysis
6258
env:
6359
APPID: ${{ secrets.APPID }}
6460
APPKEY: ${{ secrets.APPKEY }}

0 commit comments

Comments
 (0)