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

Release: v1.0.1

Author: ForteScarlet

.changelog/v1.0.1.md

@@ -0,0 +1,7 @@
+> 对应核心版本: [**v4.1.0**](https://github.com/simple-robot/simpler-robot/releases/tag/v4.1.0)
+
+
+我们欢迎并期望着您的的[反馈](https://github.com/simple-robot/simbot-component-onebot/issues)或[协助](https://github.com/simple-robot/simbot-component-onebot/pulls)，
+感谢您的贡献与支持！
+
+也欢迎您为我们献上一颗 `star`，这是对我们最大的鼓励与认可！

.github/workflows/deploy-website.yml

@@ -4,7 +4,7 @@ on:
     branches:
       - main
       - master
-#      - dev/main
+      - dev/main
     paths:
       - 'Writerside/**'
       - '.github/workflows/deploy-website.yml'
@@ -123,31 +123,31 @@ jobs:
         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-3
-
-    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
+#  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-3
+#
+#    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/publish-kdoc.yml

@@ -0,0 +1,55 @@
+name: Publish KDoc
+on:
+  workflow_dispatch:
+
+
+env:
+  JAVA_VERSION: 21
+  JAVA_DISTRIBUTION: zulu
+  GRADLE_VERSION: 8.5
+  IS_CI: true
+  GPG_KEY_ID: ${{ secrets.GPG_KEY_ID }}
+  GPG_SECRET_KEY: ${{ secrets.GPG_SECRET_KEY }}
+  GPG_PASSWORD: ${{ secrets.GPG_PASSWORD }}
+  SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
+  SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
+  GRADLE_OPTS: "-XX:MaxMetaspaceSize=2g -Dfile.encoding=UTF-8"
+
+jobs:
+  deploy-doc:
+    name: Deploy KDoc
+    runs-on: ubuntu-latest
+    steps:
+      # 检出仓库代码
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+      # setup Java
+      - uses: actions/setup-java@v4
+        with:
+          distribution: ${{ env.JAVA_DISTRIBUTION }}
+          java-version: ${{ env.JAVA_VERSION }}
+
+      - name: Generate documentation
+        uses: gradle/actions/setup-gradle@v3
+        with:
+          gradle-version: ${{ env.GRADLE_VERSION }}
+          arguments: |
+            dokkaHtmlMultiModule 
+            --info 
+            --warning-mode all 
+            -x test 
+            --build-cache 
+            -Porg.gradle.jvmargs="-Xmx8g -Xms2g -XX:MaxMetaspaceSize=1g -Dfile.encoding=UTF-8" 
+
+      - name: Push to doc repository
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          personal_token: ${{ secrets.PUSH_TOKEN }}
+          external_repository: simple-robot-library/simbot3-api-docs
+          publish_branch: kdoc-deploy/component-onebot
+          publish_dir: ./build/dokka/html
+          # deploy to sub dir
+          destination_dir: components/onebot
+

.github/workflows/publish-snapshot.yml

@@ -16,10 +16,13 @@ on:
       - 'build.gradle.kts'
       - 'settings.gradle.kts'
       - 'gradle.properties'
-
+    tags-ignore:
+      - v**
   # 手动触发工作流
   workflow_dispatch:
 
+
+
 env:
   JAVA_VERSION: 21
   JAVA_DISTRIBUTION: zulu

.simbot/dokka-assets/css/kdoc-style.css

@@ -1,8 +1,26 @@
-.library-name a::before {
-    background: url("../images/logo-icon.svg") center no-repeat;
-    background-size: contain;
-    width: 40px;
-    height: 40px;
-    top: -12px;
-    left: -50px;
+/*
+ *     Copyright (c) 2024. ForteScarlet.
+ *
+ *     Project    https://github.com/simple-robot/simpler-robot
+ *     Email      [email protected]
+ *
+ *     This file is part of the Simple Robot Library (Alias: simple-robot, simbot, etc.).
+ *
+ *     This program is free software: you can redistribute it and/or modify
+ *     it under the terms of the GNU Lesser General Public License as published by
+ *     the Free Software Foundation, either version 3 of the License, or
+ *     (at your option) any later version.
+ *
+ *     This program is distributed in the hope that it will be useful,
+ *     but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *     Lesser GNU General Public License for more details.
+ *
+ *     You should have received a copy of the Lesser GNU General Public License
+ *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+:root {
+    --dokka-logo-image-url: url('../images/logo-icon-light.svg');
 }