Skip to content

Commit

Permalink
docs: add deploy guide.
Browse files Browse the repository at this point in the history
  • Loading branch information
kazami139 authored and GitHub Enterprise committed Mar 6, 2023
1 parent 25ad00c commit c926406
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,12 @@ eoefans api支持

- [全球访问](https://portal.api.eoe.best/api-details#api=eoefans-api)

## 使用指南
- Dependabot每周五上午09点自动检查```Main```分支的依赖。请及时查看Dependabot开启的[PR](https://vlink.dev/EOEFANS/eoefans-api/pulls?q=is%3Apr+is%3Aopen+label%3Adependencies)并根据需要合并。若PR开启的节点较为落后,可使用```@dependabot rebase```回复相应PR[示例](https://vlink.dev/EOEFANS/eoefans-api/pull/9#issuecomment-10)),让bot重新提交Commit。
### CI/CD指南
打tag自动构建镜像,tag格式符合[语义化版本](https://semver.org/lang/zh-CN/)[示例](https://vlink.dev/Asterism/kira-api-server/actions/runs/744)

- ```Main```分支打tag后自动构建。tag规格:```v*.*.*```
部署请前往[eoefans api Azure deploy](https://vlink.dev/EOEFANS/eoefans-api/actions/workflows/eoefans-api-azure-deploy.yml)[eoefans spider Azure deploy](https://vlink.dev/EOEFANS/eoefans-api/actions/workflows/eoefans-spider-azure-deploy.yml),选择手动执行并指定tag。

- 构建后的镜像可在[组织镜像页面](https://vlink.dev/orgs/EOEFANS/packages)或右侧```Packages```查看。这步不是必须的,不过最好在部署前手动确认最新版镜像已经发布。

- 需要部署的话,请将 ```Main``` 提起PR至 ```release``` 分支,后合并入 ```release``` 分支。部署将自动排队并等待手动通过。请前往 [Actioins](https://vlink.dev/EOEFANS/eoefans-api/actions) 审阅。手动通过相关部署后,部署即可完成。
发布新版时,```sentry_release```必填true或1。回滚/部署旧版时填写任意值即可。

## 环境

Expand Down

0 comments on commit c926406

Please sign in to comment.