From f1cefad910907341a9a9477ec34a56482f6e61b2 Mon Sep 17 00:00:00 2001 From: Whale Date: Tue, 2 Mar 2021 13:37:07 +0800 Subject: [PATCH 01/11] Create deploy-docs.yml --- .github/workflows/deploy-docs.yml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/workflows/deploy-docs.yml diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml new file mode 100644 index 00000000..f9fc3797 --- /dev/null +++ b/.github/workflows/deploy-docs.yml @@ -0,0 +1,22 @@ +name: Publish docs via GitHub Pages +on: + push: + branches: + - master + +jobs: + build: + name: Deploy docs + runs-on: ubuntu-latest + steps: + - name: Checkout main + uses: actions/checkout@v2 + + - name: Deploy docs + uses: mhausenblas/mkdocs-deploy-gh-pages@master + # Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + CUSTOM_DOMAIN: docs-v2.zhamao.me + CONFIG_FILE: mkdocs.yml + EXTRA_PACKAGES: build-base From a2d4bab062b494cc87a731ff843f066f1c76fc0f Mon Sep 17 00:00:00 2001 From: Whale Date: Tue, 2 Mar 2021 13:40:21 +0800 Subject: [PATCH 02/11] Update index.md --- docs/index.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/index.md b/docs/index.md index a4fc5c74..f5b3cb8b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,14 +8,13 @@ 编写文档需要较大精力，你也可以参与到本文档的建设中来，比如找错字，增加或更正内容，每页文档可直接点击右上方铅笔图标直接跳转至 GitHub 进行编辑，编辑后自动 Fork 并生成 Pull Request，以此来贡献此文档！ +炸毛框架使用 PHP 编写，采用 Swoole 扩展为基础，主要面向 API 服务，聊天机器人（OneBot 标准的机器人对接），包含 WebSocket、HTTP 等监听和请求库，用户代码采用模块化处理，使用注解可以方便地编写各类功能。 -炸毛框架使用 PHP 编写，采用 Swoole 扩展为基础，主要面向 API 服务，聊天机器人（CQHTTP 对接），包含 websocket、http 等监听和请求库，用户代码采用模块化处理，使用注解可以方便地编写各类功能。 - -框架主要用途为 HTTP 服务器，机器人搭建框架。尤其对于 QQ 机器人消息处理较为方便和全面，提供了众多会话机制和内部调用机制，可以以各种方式设计你自己的模块。 +框架主要用途为 HTTP/WS 服务器，机器人搭建框架。尤其对于聊天机器人消息处理较为方便和全面，提供了众多会话机制和内部调用机制，可以以各种方式设计你自己的模块。 在 HTTP 和 WebSocket 服务器上，PHP 的扩展 Swoole 提供了高性能的支持，使其效率可媲美 nginx 静态网页处理的效率。 -此外，QQ 机器人方面此框架基于 OneBot 标准的反向 WebSocket 连接，比传统 HTTP 通信更快，未来也会兼容微信公众号开发者模式。 +此外，QQ 机器人方面此框架基于 OneBot 标准的反向 WebSocket 连接，比传统 HTTP 通信更快。 ```php /** @@ -39,9 +38,9 @@ public function index() { 首先，你需要了解你需要知道哪些事情才能开始着手使用框架： 1. Linux 命令行（会跑 Linux 程序） -2. php 7.2+ 开发环境 -3. HTTP 协议（可选） -4. OneBot 机器人聊天接口标准（可选） +2. php 7.2+ 开发环境（项目会持续支持最新的 PHP 版本） +3. HTTP/WebSocket 协议 +4. OneBot 机器人聊天接口标准 需要值得注意的是，本教程中所涉及的内容均为尽可能翻译为白话的方式进行描述，但对于框架的组件或事件等需要单独拆分说明文档的部分则需要足够详细，所以本教程提供一个快速上手的教程，并且会将最典型的安装方式写到快速教程篇。 From 6e1f3e04060f75674c4f56ee793a6100c5ad9a8c Mon Sep 17 00:00:00 2001 From: Whale Date: Tue, 2 Mar 2021 13:43:45 +0800 Subject: [PATCH 03/11] Update deploy-docs.yml --- .github/workflows/deploy-docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index f9fc3797..2c9bc983 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -17,6 +17,7 @@ jobs: # Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GITHUB_REPOSITORY: zhamao-robot/docs-v2-pages CUSTOM_DOMAIN: docs-v2.zhamao.me CONFIG_FILE: mkdocs.yml EXTRA_PACKAGES: build-base From 9b7802ac045daad457777d8c09a7fa4f29ac384a Mon Sep 17 00:00:00 2001 From: Whale Date: Tue, 2 Mar 2021 13:50:39 +0800 Subject: [PATCH 04/11] Update deploy-docs.yml --- .github/workflows/deploy-docs.yml | 24 ++++++++---------------- 1 file changed, 8 insertions(+), 16 deletions(-) diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 2c9bc983..e34009dc 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -1,23 +1,15 @@ -name: Publish docs via GitHub Pages +name: ci on: push: branches: - master - jobs: - build: - name: Deploy docs + deploy: runs-on: ubuntu-latest steps: - - name: Checkout main - uses: actions/checkout@v2 - - - name: Deploy docs - uses: mhausenblas/mkdocs-deploy-gh-pages@master - # Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - GITHUB_REPOSITORY: zhamao-robot/docs-v2-pages - CUSTOM_DOMAIN: docs-v2.zhamao.me - CONFIG_FILE: mkdocs.yml - EXTRA_PACKAGES: build-base + - uses: actions/checkout@v2 + - uses: actions/setup-python@v2 + with: + python-version: 3.x + - run: pip install mkdocs-material + - run: mkdocs build -d distribute && git init && git add -A && git commit -m 'deploy' && git push -f https://github.com/zhamao-robot/docs-v2-pages.git master From d9b8df172574b9617d07ba4a0c0d30318c541340 Mon Sep 17 00:00:00 2001 From: Whale Date: Tue, 2 Mar 2021 13:50:52 +0800 Subject: [PATCH 05/11] Update deploy-docs.yml --- .github/workflows/deploy-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index e34009dc..84388f57 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -12,4 +12,4 @@ jobs: with: python-version: 3.x - run: pip install mkdocs-material - - run: mkdocs build -d distribute && git init && git add -A && git commit -m 'deploy' && git push -f https://github.com/zhamao-robot/docs-v2-pages.git master + - run: mkdocs build -d distribute && cd distribute && git init && git add -A && git commit -m 'deploy' && git push -f https://github.com/zhamao-robot/docs-v2-pages.git master From fc8d01ad5fa6cb11dca47c048f1fbdad8c068b36 Mon Sep 17 00:00:00 2001 From: Whale Date: Tue, 2 Mar 2021 13:53:12 +0800 Subject: [PATCH 06/11] Update deploy-docs.yml --- .github/workflows/deploy-docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 84388f57..0d70dfc4 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -12,4 +12,5 @@ jobs: with: python-version: 3.x - run: pip install mkdocs-material + - run: git config --global user.email "jesse2061@outlook.com" && git config --global user.name "crazywhalecc" - run: mkdocs build -d distribute && cd distribute && git init && git add -A && git commit -m 'deploy' && git push -f https://github.com/zhamao-robot/docs-v2-pages.git master From 98bfca5bb9e51b1fd01f810f28c0a40c313575b8 Mon Sep 17 00:00:00 2001 From: Whale Date: Tue, 2 Mar 2021 14:18:40 +0800 Subject: [PATCH 07/11] Update deploy-docs.yml --- .github/workflows/deploy-docs.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 0d70dfc4..cc3adea1 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -9,8 +9,9 @@ jobs: steps: - uses: actions/checkout@v2 - uses: actions/setup-python@v2 + - uses: shimataro/ssh-key-action@v2 with: python-version: 3.x + key: ${{ secrets.SSH_KEY }} - run: pip install mkdocs-material - - run: git config --global user.email "jesse2061@outlook.com" && git config --global user.name "crazywhalecc" - - run: mkdocs build -d distribute && cd distribute && git init && git add -A && git commit -m 'deploy' && git push -f https://github.com/zhamao-robot/docs-v2-pages.git master + - run: mkdocs build -d distribute && cd distribute/ && ssh root@139.199.77.130 rm -rf /var/www/docs_v2/\* && scp -r ./* root@139.199.77.130:/var/www/docs_v2/ From 8740c3c25522690afe3c8f6487189522f94c4527 Mon Sep 17 00:00:00 2001 From: Whale Date: Tue, 2 Mar 2021 14:19:51 +0800 Subject: [PATCH 08/11] Update deploy-docs.yml --- .github/workflows/deploy-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index cc3adea1..97c07beb 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -12,6 +12,6 @@ jobs: - uses: shimataro/ssh-key-action@v2 with: python-version: 3.x - key: ${{ secrets.SSH_KEY }} + key: ${{ secrets.VPS_SSH }} - run: pip install mkdocs-material - run: mkdocs build -d distribute && cd distribute/ && ssh root@139.199.77.130 rm -rf /var/www/docs_v2/\* && scp -r ./* root@139.199.77.130:/var/www/docs_v2/ From 455fc79818f625d725d1a188af0940fbc33016d1 Mon Sep 17 00:00:00 2001 From: Whale Date: Tue, 2 Mar 2021 14:22:40 +0800 Subject: [PATCH 09/11] Update deploy-docs.yml --- .github/workflows/deploy-docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 97c07beb..3d16bd73 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -13,5 +13,6 @@ jobs: with: python-version: 3.x key: ${{ secrets.VPS_SSH }} + known_hosts: ${{ secrets.KNOWN_HOSTS }} - run: pip install mkdocs-material - run: mkdocs build -d distribute && cd distribute/ && ssh root@139.199.77.130 rm -rf /var/www/docs_v2/\* && scp -r ./* root@139.199.77.130:/var/www/docs_v2/ From 275a7bf00ba3b684faafe90b31b1a883123188f6 Mon Sep 17 00:00:00 2001 From: Whale Date: Tue, 2 Mar 2021 14:26:02 +0800 Subject: [PATCH 10/11] Update deploy-docs.yml --- .github/workflows/deploy-docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 3d16bd73..35c50e64 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -13,6 +13,7 @@ jobs: with: python-version: 3.x key: ${{ secrets.VPS_SSH }} + name: id_rsa known_hosts: ${{ secrets.KNOWN_HOSTS }} - run: pip install mkdocs-material - run: mkdocs build -d distribute && cd distribute/ && ssh root@139.199.77.130 rm -rf /var/www/docs_v2/\* && scp -r ./* root@139.199.77.130:/var/www/docs_v2/ From 24e70c70ce16510763dcfba7c1847a74f7f523d0 Mon Sep 17 00:00:00 2001 From: Whale Date: Tue, 2 Mar 2021 14:27:55 +0800 Subject: [PATCH 11/11] Update deploy-docs.yml --- .github/workflows/deploy-docs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 35c50e64..3d16bd73 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -13,7 +13,6 @@ jobs: with: python-version: 3.x key: ${{ secrets.VPS_SSH }} - name: id_rsa known_hosts: ${{ secrets.KNOWN_HOSTS }} - run: pip install mkdocs-material - run: mkdocs build -d distribute && cd distribute/ && ssh root@139.199.77.130 rm -rf /var/www/docs_v2/\* && scp -r ./* root@139.199.77.130:/var/www/docs_v2/