Merge pull request #134 from simple-robot/dev/main

Release: v4.0.0-beta1

.changelog/v4.0.0-beta1.md

@@ -0,0 +1,7 @@
+> 对应核心版本: [**v4.0.0-beta1**](https://github.com/simple-robot/simpler-robot/releases/tag/v4.0.0-beta1)
+    
+> [!warning]
+> 目前版本尚处于 **`beta`** 阶段，代表仍然可能存在部分已知问题或未知问题，
+> 以及尚未完善的内容和落后于官方更新的内容。
+
+我们欢迎并期望着您的 [反馈](https://github.com/simple-robot/simbot-component-kook/issues) 或 [协助](https://github.com/simple-robot/simbot-component-kook/pulls)，感谢您的贡献与支持！

.changelog/v4.0.0-dev1.md

@@ -0,0 +1,8 @@
+> 对应核心版本: [**v4.0.0-dev18**](https://github.com/simple-robot/simpler-robot/releases/tag/v4.0.0-dev18)
+    
+> [!warning]
+> 目前版本尚处于 **`dev`** 阶段，代表仍然可能存在部分已知问题或未知问题，
+> 以及尚未完善的内容和落后于官方更新的内容。
+
+我们欢迎并期望着您的 [反馈](https://github.com/simple-robot/simbot-component-kook/issues) 或 [协助](https://github.com/simple-robot/simbot-component-kook/pulls)，
+感谢您的贡献与支持！

.changelog/v4.0.0-dev2.md

@@ -0,0 +1,7 @@
+> 对应核心版本: [**v4.0.0-dev18**](https://github.com/simple-robot/simpler-robot/releases/tag/v4.0.0-dev18)
+    
+> [!warning]
+> 目前版本尚处于 **`dev`** 阶段，代表仍然可能存在部分已知问题或未知问题，
+> 以及尚未完善的内容和落后于官方更新的内容。
+
+我们欢迎并期望着您的 [反馈](https://github.com/simple-robot/simbot-component-kook/issues) 或 [协助](https://github.com/simple-robot/simbot-component-kook/pulls)，感谢您的贡献与支持！

.changelog/v4.0.0-dev3.md

@@ -0,0 +1,7 @@
+> 对应核心版本: [**v4.0.0-dev18**](https://github.com/simple-robot/simpler-robot/releases/tag/v4.0.0-dev18)
+    
+> [!warning]
+> 目前版本尚处于 **`dev`** 阶段，代表仍然可能存在部分已知问题或未知问题，
+> 以及尚未完善的内容和落后于官方更新的内容。
+
+我们欢迎并期望着您的 [反馈](https://github.com/simple-robot/simbot-component-kook/issues) 或 [协助](https://github.com/simple-robot/simbot-component-kook/pulls)，感谢您的贡献与支持！

.github/FUNDING.yml

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: ForteScarlet
+patreon: ForteScarlet
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+  - package-ecosystem: gradle
+    directory: /
+    target-branch: "dev/main"
+    schedule:
+      interval: weekly
+    labels:
+      - dependencies

.github/release.yml

@@ -16,6 +16,9 @@ changelog:
     - title: '✨ 优化'
       labels:
         - '优化'
+    - title: '📦 依赖更新'
+      labels:
+        - 'dependencies'
     - title: '👀 其他变更'
       labels:
         - '*'

.github/workflows/deploy-website-v4.yml

@@ -0,0 +1,153 @@
+name: Deploy Website
+on:
+  push:
+    branches:
+      - main
+      - dev/ver/**
+      - dev/main
+
+    paths:
+      - 'Writerside/**'
+      - '.github/workflows/deploy-website-v4.yml'
+
+    tags-ignore:
+      - v4.**.**
+  # Specify to run a workflow manually from the Actions tab on GitHub
+  workflow_dispatch:
+
+# Gives the workflow permissions to clone the repo and create a page deployment
+permissions:
+  id-token: write
+  pages: write
+
+env:
+  # Name of module and id separated by a slash
+  INSTANCE: Writerside/kook
+  INSTANCE_NAME: kook
+  # Replace HI with the ID of the instance in capital letters
+  ARTIFACT: webHelpKOOK2-all.zip
+  # Writerside docker image version
+  DOCKER_VERSION: 233.14272
+  # Add the variable below to upload Algolia indexes
+  # Replace HI with the ID of the instance in capital letters
+  ALGOLIA_ARTIFACT: algolia-indexes-KOOK.zip
+  ALGOLIA_APP_NAME: VLLZ4JZE8Z
+  ALGOLIA_INDEX_NAME: kook-doc
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    outputs:
+      config_json: ${{ steps.output-config-json.outputs.config_json }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Build Writerside docs using Docker
+        uses: JetBrains/writerside-github-action@v4
+        with:
+          instance: ${{ env.INSTANCE }}
+          artifact: ${{ env.ARTIFACT }}
+          docker-version: ${{ env.DOCKER_VERSION }}
+
+      - name: Upload documentation
+        uses: actions/upload-artifact@v3
+        with:
+          name: docs
+          path: |
+            artifacts/${{ env.ARTIFACT }}
+            artifacts/report.json
+          retention-days: 7
+
+      # Add the step below to upload Algolia indexes
+      - name: Upload algolia-indexes
+        uses: actions/upload-artifact@v3
+        with:
+          name: algolia-indexes
+          path: artifacts/${{ env.ALGOLIA_ARTIFACT }}
+          retention-days: 7
+
+      - name: Unzip artifact
+        run: unzip -O UTF-8 -qq artifacts/${{ env.ARTIFACT }} -d dir
+
+      - name: Output documentation config.json
+        id: output-config-json
+        run: |
+          echo "config_json=$(cat dir/config.json)" >> $GITHUB_OUTPUT
+
+  # Add the job below and artifacts/report.json on Upload documentation step above if you want to fail the build when documentation contains errors
+  test:
+    # Requires build job results
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v1
+        with:
+          name: docs
+          path: artifacts
+
+      - name: Test documentation
+        uses: JetBrains/writerside-checker-action@v1
+        with:
+          instance: ${{ env.INSTANCE }}
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    # Requires the build job results
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: docs
+
+      - name: Unzip artifact
+        run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v2
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: dir
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1
+
+  # https://www.jetbrains.com/help/writerside/configure-search.html
+  publish-indexes:
+    # Requires the build-job results
+    needs: [build, test]
+    runs-on: ubuntu-latest
+    container:
+      image: registry.jetbrains.team/p/writerside/builder/algolia-publisher:2.0.32-2
+
+    env:
+
+      CONFIG_JSON_VERSION: ${{ fromJSON(needs.build.outputs.config_json).productVersion }}
+
+    steps:
+      - name: Download artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: algolia-indexes
+
+      - name: Unzip artifact
+        run: |
+          unzip -O UTF-8 -qq ${{ env.ALGOLIA_ARTIFACT }} -d algolia-indexes
+          env "algolia-key=${{secrets.ALGOLIA_KEY}}" java -jar /opt/builder/help-publication-agent.jar \
+          update-index \
+          --application-name ${{env.ALGOLIA_APP_NAME}} \
+          --index-name ${{env.ALGOLIA_INDEX_NAME}} \
+          --product ${{env.INSTANCE_NAME}} \
+          --version ${{env.CONFIG_JSON_VERSION}} \
+          --index-directory algolia-indexes/ \
+          2>&1 | tee algolia-update-index-log.txt

.github/workflows/deploy-website.yml → .github/workflows/deploy-website.yml.bk

@@ -16,7 +16,7 @@ jobs:
     name: Deploy Website
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v3
         with:
           node-version: 16.x

.github/workflows/doc-test-branch.yml → .github/workflows/doc-test-branch.yml.bk

@@ -15,7 +15,7 @@ jobs:
     name: Build Website
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v3
         with:
           node-version: 16.x