Skip to content

Commit

Permalink
Fix: Document CI process and some issues
Browse files Browse the repository at this point in the history
  • Loading branch information
6get-xiaofan committed Sep 11, 2024
1 parent 81aeee1 commit 85edf35
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/version.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
version: 2.0.0
version: 2.1.0
20 changes: 19 additions & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,28 @@ jobs:
echo "Updating version from $CURRENT_VERSION to $NEW_VERSION"
echo "NEW_VERSION=${NEW_VERSION}" >> $GITHUB_ENV
- name: Stop if no version update
if: env.NEW_VERSION == 'null'
run: echo "No version update needed. Stopping workflow."

- name: Update version.yml
if: env.NEW_VERSION != 'null'
run: |
yq eval ".version = \"$NEW_VERSION\"" -i .github/version.yml
- name: Commit updated version.yml
if: env.NEW_VERSION != 'null'
run: |
git config --global user.name "github-actions"
git config --global user.email "[email protected]"
git add .github/version.yml
git commit -m "chore: update version to $NEW_VERSION"
git push
- name: Create Release
id: create_release
uses: actions/create-release@v1
if: steps.update_version.outputs.NEW_VERSION != 'null'
if: env.NEW_VERSION != 'null'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
Expand Down
6 changes: 4 additions & 2 deletions docs/apis/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
7. 服务器返回最新版本的游戏增量包。
8. 客户端将最新版本的游戏覆盖安装到本地。

![Update process](../../public/lc1.png "Update process")
![Update process](https://doc.dooper.top/lc1.png "Update process")

## getLatestVersion

Expand Down Expand Up @@ -174,6 +174,8 @@

下载增量包,将 GenerateIncrementalPackage 返回的 packageHash 参数传入后,服务器会返回文件,客户端接收即可。

或者使用 getUpdateFileList API 之后,将 UUID 参数传入后,服务器也会返回文件,客户端接收即可。

| 请求方式 | GET |
| -------- | ---------------------------------- |
| 请求地址 | /v1/update/download |
Expand All @@ -188,7 +190,7 @@

| 参数 | 必填 | 简介 | 类型 | 示例值 |
| ----- | ---- | -------- | ------ | ------------------ |
| params || 文件哈希值 | String | 8DF7S9ADF87S9 |
| fileHash || 文件哈希值或 UUID | String | 8DF7S9ADF87S9 |

请求示例:

Expand Down
2 changes: 1 addition & 1 deletion docs/contribution/standard.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@

你可以在下图中看到这些 `repo` 之间的关系:

![Repo Diagram](../../public/sd1.png "Repo Diagram")
![Repo Diagram](https://doc.dooper.top/sd1.png "Repo Diagram")

## 开始

Expand Down
1 change: 0 additions & 1 deletion update-timeline.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: 更新时间轴
aside: false
---
# 更新时间轴

Expand Down

0 comments on commit 85edf35

Please sign in to comment.