Merge pull request #40 from gregPerlinLi/dev

CI/CD Enhancements and Database Support for CertVault

Author: gregPerlinLi

.github/workflows/backend-ci.yaml

@@ -25,6 +25,13 @@ jobs:
       attestations: write
       id-token: write
 
+    services:
+      redis:
+        image: redis
+        ports:
+          - 6379:6379
+        options: --health-cmd "redis-cli ping" --health-interval 10s --health-timeout 5s --health-retries 5
+
     steps:
       # 检出代码
       - name: Checkout code
@@ -102,6 +109,12 @@ jobs:
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
 
+      - name: Generate OpenAPI Documentation
+        run: |       # 启动应用并导出 YAML 格式文档
+          java -jar server/target/*.jar --spring.profiles.active=ci &
+          sleep 20
+          curl http://localhost:1888/api/docs.yaml > openapi.yaml
+
       - name: Set up environment variable
         run: echo "VERSION=${{ env.VERSION }}" > version.env
 
@@ -111,6 +124,12 @@ jobs:
           name: version
           path: version.env
 
+      - name: Upload API Doc Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: openapi-doc
+          path: openapi.yaml
+
   deploy-helm:
     runs-on: ubuntu-latest
     needs: build-backend
@@ -166,3 +185,42 @@ jobs:
           git add .
           git commit -m "${{ github.event.head_commit.message }}" || echo "No changes to commit"
           git push origin main
+
+  publish-api-doc:
+    runs-on: ubuntu-latest
+    needs: build-backend
+    permissions:
+      contents: write
+    steps:
+      # 下载生成的 OpenAPI 文档
+      - name: Download OpenAPI artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: openapi-doc
+          path: .
+
+      # 检出 CertVaultAPIDoc 仓库
+      - name: Checkout CertVaultAPIDoc repo
+        uses: actions/checkout@v4
+        with:
+          repository: gregPerlinLi/certvault-api-doc
+          token: ${{ secrets.CERT_VAULT_API_DOC_TOKEN }}
+          path: certvault-api-doc
+          ref: main
+
+      # 替换并提交 OpenAPI 文档
+      - name: Update OpenAPI file
+        run: |          
+          cp ./openapi.yaml certvault-api-doc/
+          cd certvault-api-doc
+          git config --global user.name "GitHub Actions"
+          git config --global user.email "actions@github.com"
+          git add openapi.yaml
+          git commit -m "Update OpenAPI documentation" || echo "No changes to commit"
+          cd ..
+
+      # 推送变更到 CertVaultAPIDoc
+      - name: Push changes to CertVaultAPIDoc
+        run: |          
+          cd certvault-api-doc
+          git push origin main

README.md

@@ -113,10 +113,15 @@ docker compose -f docker-compose-with-postgres-redis.yml up -d
 - [How to deployment](docs/Deployment.md)
 - How to use
 
+## ⚙️ API Documentation
+
+[CertVault API Documentation](https://gregperlinli.github.io/certvault-api-doc/)
+
 ## 🧰 Related Projects
 
 - [CertVault CLI](https://github.com/gregPerlinLi/CertVaultCLI): A CLI tool for CertVault Platform
 - [CertVault Charts](https://github.com/gregPerlinLi/certvault-charts): Helm Charts for CertVault Platform
+- [CertVault API Docs](https://github.com/gregPerlinLi/certvault-api-doc): API documentation for CertVault Platform
 
 ## 📊 Statistics
 

README_CN.md

@@ -115,6 +115,10 @@ docker compose -f docker-compose-with-postgres-redis.yml up -d
 - [如何部署](docs/Deployment_CN.md)
 - 如何使用
 
+## ⚙️ API 文档
+
+[CertVault API 文档（英文）](https://gregperlinli.github.io/certvault-api-doc/)
+
 ## 🧰 相关项目
 
 - [CertVault CLI](https://github.com/gregPerlinLi/CertVaultCLI): CertVault 的命令行工具

frontend/package.json

@@ -16,7 +16,7 @@
     "lodash": "^4.17.21",
     "primeicons": "^7.0.0",
     "primevue": "^4.3.3",
-    "tailwindcss": "^4.1.4",
+    "tailwindcss": "^4.1.5",
     "tailwindcss-primeui": "^0.5.1",
     "valibot": "^1.0.0",
     "vue": "^3.5.13",
@@ -25,7 +25,7 @@
   "devDependencies": {
     "@primeuix/themes": "^1.0.3",
     "@primevue/auto-import-resolver": "^4.3.3",
-    "@tailwindcss/vite": "^4.1.4",
+    "@tailwindcss/vite": "^4.1.5",
     "@types/lodash": "^4.17.16",
     "@vitejs/plugin-vue": "^5.2.3",
     "@vue/tsconfig": "^0.7.0",
@@ -34,7 +34,7 @@
     "typescript": "~5.8.3",
     "unplugin-auto-import": "^19.1.2",
     "unplugin-vue-components": "^28.5.0",
-    "vite": "^6.3.3",
+    "vite": "^6.3.4",
     "vite-tsconfig-paths": "^5.1.4",
     "vitest": "^3.1.2",
     "vue-tsc": "^2.2.10"