update ci/cd 2

tianjixuetu · tianjixuetu · commit dbab31250eeb · 2025-07-25T15:35:04.000+08:00
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -37,7 +37,17 @@ jobs:
         pip install sphinx sphinx-rtd-theme sphinx-autodoc-typehints nbsphinx
         pip install -e .
         
+    - name: Check if docs exist
+      id: check_docs
+      run: |
+        if [ -d "docs" ] && [ -f "docs/conf.py" ] || [ -f "docs/source/conf.py" ]; then
+          echo "docs_exist=true" >> $GITHUB_OUTPUT
+        else
+          echo "docs_exist=false" >> $GITHUB_OUTPUT
+        fi
+        
     - name: Build documentation
+      if: steps.check_docs.outputs.docs_exist == 'true'
       run: |
         # Create docs directory if it doesn't exist
         mkdir -p docs/_build
@@ -48,11 +58,18 @@ jobs:
         # Build HTML documentation
         cd docs && make html || echo "Documentation build completed with warnings"
         
+    - name: Create simple documentation
+      if: steps.check_docs.outputs.docs_exist == 'false'
+      run: |
+        mkdir -p public
+        cp README.md public/
+        echo "<html><head><meta http-equiv='refresh' content='0; url=https://github.com/cloudQuant/backtrader#readme'></head></html>" > public/index.html
+        
     - name: Upload documentation artifacts
       uses: actions/upload-artifact@v4
       with:
         name: documentation
-        path: docs/_build/html/
+        path: ${{ steps.check_docs.outputs.docs_exist == 'true' && 'docs/_build/html/' || 'public/' }}
         retention-days: 30
 
   deploy-docs:
diff --git a/.github/workflows/sync.yml b/.github/workflows/sync.yml
@@ -11,6 +11,8 @@ on:
 jobs:
   sync:
     runs-on: ubuntu-latest
+    # Only run if SYNC_GITHUB_TOKEN secret is set
+    if: ${{ secrets.SYNC_GITHUB_TOKEN != '' }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4
diff --git a/README.md b/README.md
@@ -5,7 +5,6 @@
 [![CI Tests](https://github.com/cloudQuant/backtrader/actions/workflows/tests.yml/badge.svg?branch=master)](https://github.com/cloudQuant/backtrader/actions/workflows/tests.yml)
 [![Python](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)](https://www.python.org/)
 [![License](https://img.shields.io/badge/license-GPL%203.0-green)](LICENSE)
-[![PyPI](https://img.shields.io/badge/pypi-v1.9.76.123-orange)](https://pypi.org/project/backtrader/)
 
 [![Code style: flake8](https://img.shields.io/badge/code%20style-flake8-black)](https://flake8.pycqa.org/)
 [![GitHub stars](https://img.shields.io/github/stars/cloudQuant/backtrader?style=social)](https://github.com/cloudQuant/backtrader/stargazers)
diff --git a/SYNC_SETUP.md b/SYNC_SETUP.md
@@ -14,16 +14,17 @@ This guide explains how to set up automatic synchronization between Gitee and Gi
    - Select scopes: `repo` (full control of private repositories)
    - Copy the generated token
 
-2. Add the token to your Gitee repository secrets / 将令牌添加到 Gitee 仓库密钥
-   - Go to your Gitee repository settings
-   - Navigate to CI/CD → Secret Variables
+2. Add the token to your repository secrets / 将令牌添加到仓库密钥
+   - **For GitHub Actions**: Go to Settings → Secrets and variables → Actions
    - Add a new secret named `SYNC_GITHUB_TOKEN` with your GitHub token
+   - Note: The sync workflow will only run if this secret is set
 
 ### How it works / 工作原理
 
 The `.github/workflows/sync.yml` workflow will automatically:
 - Trigger on pushes to master, main, or dev branches
 - Push all changes to https://github.com/cloudQuant/backtrader.git
+- Only run if `SYNC_GITHUB_TOKEN` secret is configured
 
 ## Method 2: Manual Sync Scripts / 方法2：手动同步脚本
 
