fix doc

guoshiqiufeng · Aug 30, 2024 · 58b69af · 58b69af
1 parent e6090b6
commit 58b69af
Show file tree

Hide file tree

Showing 5 changed files with 83 additions and 4 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,79 @@
+name: docs
+
+on:
+  # 每当 push 到 main 分支时触发部署
+  push:
+    branches: [main]
+  # 手动触发部署
+  workflow_dispatch:
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # “最近更新时间” 等 git 日志相关信息，需要拉取全部提交记录
+          fetch-depth: 0
+
+      - name: Init VuePress
+        run: |
+          echo '{
+             "name": "spring-cloud-stream-redis-doc",
+             "version": "0.1.0",
+             "description": "spring-cloud-stream-redis doc",
+             "main": "index.js",
+             "scripts": {
+               "docs:dev": "vuepress dev docs",
+               "docs:build": "vuepress build docs"
+             },
+             "repository": {
+               "type": "git",
+               "url": "git+https://github.com/guoshiqiufeng/spring-cloud-stream-redis.git"
+             },
+             "keywords": [
+               "spring-cloud-stream",
+               "spring-cloud-stream-redis"
+             ],
+             "author": "guoshiqiufeng",
+             "license": "MIT",
+             "bugs": {
+               "url": "https://github.com/guoshiqiufeng/spring-cloud-stream-redis/issues"
+             },
+             "homepage": "https://github.com/guoshiqiufeng/spring-cloud-stream-redis#readme",
+             "devDependencies": {
+               "@vuepress/client": "^2.0.0-rc.0",
+               "@vuepress/plugin-docsearch": "^2.0.0-rc.3",
+               "vue": "^3.3.8",
+               "vuepress": "^2.0.0-rc.0"
+             },
+             "dependencies": {
+               "@vuepress/bundler-vite": "^2.0.0-rc.2",
+               "@vuepress/theme-default": "^2.0.0-rc.0"
+             }
+           }' > package.json
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          # 选择要使用的 node 版本
+          node-version: 20
+
+      - name: Build VuePress site
+        run: |
+          npm install
+          npm run docs:build
+
+      # 查看 workflow 的文档来获取更多信息
+      # @see https://github.com/crazy-max/ghaction-github-pages
+      - name: Deploy to GitHub Pages
+        uses: crazy-max/ghaction-github-pages@v4
+        with:
+          # 部署到 gh-pages 分支
+          target_branch: gh-pages
+          # 部署目录为 VuePress 的默认输出目录
+          build_dir: docs/.vuepress/dist
+        env:
+          # @see https://docs.github.com/cn/actions/reference/authentication-in-a-workflow#about-the-github_token-secret
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 ## spring-cloud-stream-redis
 
-[![Maven central](https://img.shields.io/maven-central/v/io.github.guoshiqiufeng.cloud/spring-cloud-stream-redis.svg?style=flat-square)](https://search.maven.org/search?q=g:io.github.guoshiqiufeng.cloud%20AND%20a:spring-cloud-stream-redis)
+[![Maven central](https://img.shields.io/maven-central/v/io.github.guoshiqiufeng.cloud/spring-cloud-starter-stream-redis.svg?style=flat-square)](https://search.maven.org/search?q=g:io.github.guoshiqiufeng.cloud%20AND%20a:spring-cloud-starter-stream-redis)
 [![License](https://img.shields.io/:license-apache-brightgreen.svg?style=flat-square)](http://www.apache.org/licenses/LICENSE-2.0.html)
 
 Read in other languages: [简体中文](README-zh.md)

diff --git a/docs/README.md b/docs/README.md
@@ -21,7 +21,7 @@ footer: Apache License 2.0 | Copyright © 2023-present fubluesky
 ### 最新版本
 <div style="text-align: center;">
 
-[![Maven central](https://img.shields.io/maven-central/v/io.github.guoshiqiufeng.cloud/spring-cloud-starter-stream-redis.svg?style=flat-square)](https://search.maven.org/search?q=g:io.github.guoshiqiufeng%20AND%20a:spring-cloud-starter-stream-redis)
+[![Maven central](https://img.shields.io/maven-central/v/io.github.guoshiqiufeng.cloud/spring-cloud-starter-stream-redis.svg?style=flat-square)](https://search.maven.org/search?q=g:io.github.guoshiqiufeng.cloud%20AND%20a:spring-cloud-starter-stream-redis)
 [![GitHub release](https://img.shields.io/github/release/guoshiqiufeng/spring-cloud-stream-redis.svg)](https://github.com/guoshiqiufeng/spring-cloud-stream-redis)
 
 </div>
diff --git a/docs/en/README.md b/docs/en/README.md
@@ -23,7 +23,7 @@ footer: Apache License 2.0 | Copyright © 2023-present fubluesky
 
 <div style="text-align: center;">
 
-[![Maven central](https://img.shields.io/maven-central/v/io.github.guoshiqiufeng.cloud/spring-cloud-starter-stream-redis.svg?style=flat-square)](https://search.maven.org/search?q=g:io.github.guoshiqiufeng%20AND%20a:spring-cloud-starter-stream-redis)
+[![Maven central](https://img.shields.io/maven-central/v/io.github.guoshiqiufeng.cloud/spring-cloud-starter-stream-redis.svg?style=flat-square)](https://search.maven.org/search?q=g:io.github.guoshiqiufeng.cloud%20AND%20a:spring-cloud-starter-stream-redis)
 [![GitHub release](https://img.shields.io/github/release/guoshiqiufeng/spring-cloud-stream-redis.svg)](https://github.com/guoshiqiufeng/spring-cloud-stream-redis)
 
 </div>
diff --git a/gradle.properties b/gradle.properties
@@ -1,4 +1,4 @@
 # {x-release-please-start-version}
-APP_VERSION=0.1.0
+APP_VERSION=0.1.1
 # {x-release-please-end-version}
 APP_GROUP=io.github.guoshiqiufeng.cloud