From 2685be73066192eb291d738378a92ebfe9ebd647 Mon Sep 17 00:00:00 2001 From: Jerry Ma Date: Mon, 30 Aug 2021 11:27:51 +0800 Subject: [PATCH 1/9] Create main.yml --- .github/workflows/main.yml | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 .github/workflows/main.yml diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 00000000..cb8e63bd --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,20 @@ +name: Publish docs via GitHub Pages +on: + push: + branches: + - master + +jobs: + build: + name: Deploy docs + runs-on: ubuntu-latest + steps: + - name: Checkout master + uses: actions/checkout@v2 + + - name: Deploy docs + uses: mhausenblas/mkdocs-deploy-gh-pages@master + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + CONFIG_FILE: mkdocs.yml + EXTRA_PACKAGES: build-base From e981da39327a8f4a23af6f9d0aeb8b83603a071b Mon Sep 17 00:00:00 2001 From: Jerry Ma Date: Mon, 30 Aug 2021 16:00:36 +0800 Subject: [PATCH 2/9] Update main.yml --- .github/workflows/main.yml | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index cb8e63bd..5694e3aa 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -12,9 +12,18 @@ jobs: - name: Checkout master uses: actions/checkout@v2 - - name: Deploy docs + - name: Deploy docs to GitHub Pages uses: mhausenblas/mkdocs-deploy-gh-pages@master env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} CONFIG_FILE: mkdocs.yml EXTRA_PACKAGES: build-base + - name: Deploy to Zhamao Server + uses: easingthemes/ssh-deploy@main + env: + SSH_PRIVATE_KEY: ${{ secrets.DEPLOY_SERVER_SECRET_KEY }} + ARGS: "-rltgoDzvO --delete" + SOURCE: "/github/workspace/site/" + REMOTE_HOST: ${{ secrets.DEPLOY_SERVER_HOST }} + REMOTE_USER: ${{ secrets.DEPLOY_SERVER_USER }} + TARGET: ${{ secrets.DEPLOY_SERVER_TARGET }} From 5aa0858021cdce27b28d17a4dfa9472cfd1c9c18 Mon Sep 17 00:00:00 2001 From: Jerry Ma Date: Mon, 30 Aug 2021 16:05:15 +0800 Subject: [PATCH 3/9] Update main.yml --- .github/workflows/main.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 5694e3aa..f0475615 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -21,9 +21,9 @@ jobs: - name: Deploy to Zhamao Server uses: easingthemes/ssh-deploy@main env: - SSH_PRIVATE_KEY: ${{ secrets.DEPLOY_SERVER_SECRET_KEY }} + SSH_PRIVATE_KEY: ${{ secrets.ZHAMAO_XIN_PRIVATE_KEY }} ARGS: "-rltgoDzvO --delete" SOURCE: "/github/workspace/site/" - REMOTE_HOST: ${{ secrets.DEPLOY_SERVER_HOST }} - REMOTE_USER: ${{ secrets.DEPLOY_SERVER_USER }} - TARGET: ${{ secrets.DEPLOY_SERVER_TARGET }} + REMOTE_HOST: ${{ secrets.ZHAMAO_XIN_HOST }} + REMOTE_USER: ${{ secrets.ZHAMAO_XIN_USER }} + TARGET: ${{ secrets.ZHAMAO_XIN_TARGET }} From 45c6cd7d2ac8ae6f7d8d37d61eab95323e5b1eb3 Mon Sep 17 00:00:00 2001 From: Jerry Ma Date: Mon, 30 Aug 2021 16:12:35 +0800 Subject: [PATCH 4/9] Update main.yml --- .github/workflows/main.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index f0475615..bf777945 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -18,12 +18,15 @@ jobs: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} CONFIG_FILE: mkdocs.yml EXTRA_PACKAGES: build-base + - name: Copy deployment to current folder + run: | + cp -r "${GITHUB_WORKSPACE}/site" "./deploy" - name: Deploy to Zhamao Server uses: easingthemes/ssh-deploy@main env: SSH_PRIVATE_KEY: ${{ secrets.ZHAMAO_XIN_PRIVATE_KEY }} ARGS: "-rltgoDzvO --delete" - SOURCE: "/github/workspace/site/" + SOURCE: "deploy/" REMOTE_HOST: ${{ secrets.ZHAMAO_XIN_HOST }} REMOTE_USER: ${{ secrets.ZHAMAO_XIN_USER }} TARGET: ${{ secrets.ZHAMAO_XIN_TARGET }} From 999e90f709205db9386dab76fc3b17146a5d3dbe Mon Sep 17 00:00:00 2001 From: Jerry Ma Date: Mon, 30 Aug 2021 16:17:13 +0800 Subject: [PATCH 5/9] Update index.md --- docs/index.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/index.md b/docs/index.md index e7310d72..8ca58d4c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,8 +10,6 @@ 框架主要用途为 HTTP/WS 服务器，机器人搭建框架。尤其对于聊天机器人消息处理较为方便和全面，提供了众多会话机制和内部调用机制，可以以各种方式设计你自己的模块。 -在 HTTP 和 WebSocket 服务器上，PHP 的扩展 Swoole 提供了高性能的支持，使其效率可媲美 nginx 静态网页处理的效率。 - 此外，QQ 机器人方面此框架基于 OneBot 标准的反向 WebSocket 连接，比传统 HTTP 通信更快。 ```php @@ -36,7 +34,7 @@ public function index() { 首先，你需要了解你需要知道哪些事情才能开始着手使用框架： 1. Linux 命令行（会跑 Linux 程序） -2. php 7.2+ 开发环境（项目会持续支持最新的 PHP 版本） +2. php >=7.2 开发环境（项目会持续支持最新的 PHP 版本） 4. OneBot 机器人聊天接口标准 需要值得注意的是，本教程中所涉及的内容均为尽可能翻译为白话的方式进行描述，但对于框架的组件或事件等需要单独拆分说明文档的部分则需要足够详细，所以本教程提供一个快速上手的教程，并且会将最典型的安装方式写到快速教程篇。 From 2fc42d5d60fbf0ba3e43672d40b41270f411d448 Mon Sep 17 00:00:00 2001 From: Jerry Ma Date: Mon, 30 Aug 2021 16:40:53 +0800 Subject: [PATCH 6/9] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d916c229..24f0ef76 100644 --- a/README.md +++ b/README.md @@ -52,9 +52,9 @@ vendor/bin/start server ``` ## 文档（v2 版本） -查看文档（国内自建）： +查看文档（国内自建）： -备用链接（国外托管）： +备用链接（国外托管）： 自行构建文档：`mkdocs build -d distribute` From 56cb7b222387051d5c1c31bd08ae1135ad259aa4 Mon Sep 17 00:00:00 2001 From: Jerry Ma Date: Mon, 30 Aug 2021 16:42:47 +0800 Subject: [PATCH 7/9] Update main.yml --- .github/workflows/main.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index bf777945..066d5348 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -16,6 +16,7 @@ jobs: uses: mhausenblas/mkdocs-deploy-gh-pages@master env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + CUSTOM_DOMAIN: framework.zhamao.me CONFIG_FILE: mkdocs.yml EXTRA_PACKAGES: build-base - name: Copy deployment to current folder From d300b6e5189e63fd8d771d6404ce2197cbd9be6f Mon Sep 17 00:00:00 2001 From: Jerry Ma Date: Tue, 31 Aug 2021 13:39:11 +0800 Subject: [PATCH 8/9] Update main.yml --- .github/workflows/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 066d5348..f9554157 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -1,4 +1,4 @@ -name: Publish docs via GitHub Pages +name: Docs Build on: push: branches: From d2c0972c936c209cf02f1827dc3c585ef2d149a7 Mon Sep 17 00:00:00 2001 From: Jerry Ma Date: Tue, 31 Aug 2021 13:40:29 +0800 Subject: [PATCH 9/9] Add actions badge [skip ci] --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 24f0ef76..1f441880 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ [![zhamao License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/zhamao-robot/zhamao-framework/blob/master/LICENSE) [![Latest Stable Version](http://img.shields.io/packagist/v/zhamao/framework.svg)](https://packagist.org/packages/zhamao/framework) [![Banner](https://img.shields.io/badge/OneBot-v11-success)](https://github.com/howmanybots/onebot) +![Build Actions](https://github.com/zhamao-robot/zhamao-framework/actions/workflows/main.yml/badge.svg) [![注解数量](https://img.shields.io/github/search/zhamao-robot/zhamao-framework/AnnotationBase.svg)](https://github.com/zhamao-robot/zhamao-framework/search?q=AnnotationBase) [![TODO 数量](https://img.shields.io/github/search/zhamao-robot/zhamao-framework/TODO.svg)](https://github.com/zhamao-robot/zhamao-framework/search?q=TODO)