提交 3471f8aa 编写于 作者: L Leo Fang

update README for advisor use

Signed-off-by: NLeo Fang <leofang_94@163.com>
上级 5c5d2c29
# openEuler-Advisor
## openEuler-Advisor
## Description
### Description
Collection of automation tools for easily maintaining openEuler
| Pharse | Rules | Requires | Automatic | Data & Tool |
......@@ -17,8 +17,8 @@ Collection of automation tools for easily maintaining openEuler
| 5.Release | TODO | | |
## Software Metadata
### Configs
### Software Metadata
#### Configs
```
version_control: git
src_repo: xxxx
......@@ -40,7 +40,7 @@ For example, if a software version is 1.0.0, the tag might be v1.0.0. `v` here i
**separator**
The separator of a software's version name. For example, if a software version is 1.0.0, the separator is `.`.
### How to add a software metadata file
#### How to add a software metadata file
0. Please check if the metafile is already exist
1. Copy the [Template](./template.yaml) to [Database Dir](./upstream-info)
2. Rename the file name, it is suggested that the file name SHOULD be same with the repo name in `src-openeuler`.
......@@ -50,11 +50,41 @@ The separator of a software's version name. For example, if a software version i
DONE! than you can create a Pull Request.
### Metadata Database
#### Metadata Database
[Database](./upstream-info)
#### Enviroment Setting
##### 1. necessary packages install
pip3 install python-rpm-spec (ver:0.9)
pip3 install PyYAML (ver:5.3.1)
##### 2. json file config
~/.gitee_personal_token.json
content format: {"user":"user_name","access_token":"token_passwd"}
setting personal access token: https://gitee.com/profile/personal_access_tokens
#### Use Instructions
##### 1. simple-update-root.py
single package auto-upgrade: python3 simple-update-root.py -u pkg pkg_name branch_name
ep: python3 simple-update-root.py -u pkg snappy master
## Contribution
single package manual upgrade: python3 simple-update-root.py pkg_name branch_name [-fc] [-d] [-s] [-n new_version] [-p]
ep: python3 simple-update-root.py snappy openEuler-20.03-LTS -fc -d -s -n 1.8.1
multi-packages in a repo auto-upgrade: python3 simple-update-root.py -u repo repo_name branch_name
ep: python3 simple-update-root.py -u repo src_openEuler master
##### 2. oa_upgradable.py
display all tags of target package: python3 oa_upgradable.py pkg_name
ep: python3 oa_upgradable.py glibc
#### Consultation for advisor:
if any problem, please contact: leo.fangyufa@huawei.com/leofang_94@163.com
### Contribution
1. Fork the repository
2. Create Feat_xxx branch
......
......@@ -19,8 +19,37 @@ openEuler-Advisor 的目标是为 openEuler 制品仓的日常工作提供自动
2. 对 simple-update-robot.py 做进一步的优化,提高自动化处理升级的能力。
3. 完善 upstream-info,覆盖 openEuler 制品仓中所有软件。并将分散中 openEuler 社区中的各个 YAML 统一到 upstream-info 中,便于后续统一管理。
4. 完善 oa_upgradable.py 支持的上游社区代码管理协议,当前发现还需要增加 fossil 的支持。
#### Enviroment Setting
##### 1. necessary packages install
pip3 install python-rpm-spec (ver:0.9)
pip3 install PyYAML (ver:5.3.1)
##### 2. json file config
~/.gitee_personal_token.json
content format: {"user":"user_name","access_token":"token_passwd"}
setting personal access token: https://gitee.com/profile/personal_access_tokens
#### Use Instructions
##### 1. simple-update-root.py
single package auto-upgrade: python3 simple-update-root.py -u pkg pkg_name branch_name
ep: python3 simple-update-root.py -u pkg snappy master
single package manual upgrade: python3 simple-update-root.py pkg_name branch_name [-fc] [-d] [-s] [-n new_version] [-p]
ep: python3 simple-update-root.py snappy openEuler-20.03-LTS -fc -d -s -n 1.8.1
multi-packages in a repo auto-upgrade: python3 simple-update-root.py -u repo repo_name branch_name
ep: python3 simple-update-root.py -u repo src_openEuler master
##### 2. oa_upgradable.py
display all tags of target package: python3 oa_upgradable.py pkg_name
ep: python3 oa_upgradable.py glibc
#### Consultation for advisor:
if any problem, please contact: leo.fangyufa@huawei.com/leofang_94@163.com
#### ymal文件规范
###### version_control:
......@@ -109,4 +138,4 @@ openEuler-Advisor 的目标是为 openEuler 制品仓的日常工作提供自动
有些软件的tag分域采用的不是".",这时候设置seperator就可以规范化版本tag。
如果软件tag分域本来就是".",这个时候设置seperator是不影响结果的。
\ No newline at end of file
如果软件tag分域本来就是".",这个时候设置seperator是不影响结果的。
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册