如何通过GitHub Actions将Pyvis生成的HTML部署到GitHub Pages

核心需求 #

仅依赖Pyvis包，通过GitHub Actions自动运行Python脚本生成可视化HTML，部署到GitHub Pages。

步骤1：调整Python脚本输出路径 #

修改Pyvis生成HTML的路径，将输出文件放到docs目录（适配GitHub Pages的默认部署路径）：

network = Network(directed=True, height="750px", width="100%", bgcolor="#222222", font_color="white")
# ... 你的其他配置代码 ...
network.set_edge_smooth('dynamic')
network.toggle_physics(True)
network.show_buttons(filter_=['physics'])
network.barnes_hut(gravity=-3000)
# 修改输出路径为docs目录下的graph.html
network.show("docs/graph.html", local=True, notebook=False)

步骤2：创建GitHub Actions工作流文件 #

在仓库的.github/workflows/目录下新建deploy.yml文件，写入以下内容：

name: Deploy Pyvis Graph to GitHub Pages
on:
  push:
    branches: [ main ]  # 触发部署的分支，根据你的主分支名称调整（如master）
  workflow_dispatch:  # 支持手动触发部署

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: 拉取代码
        uses: actions/checkout@v4

      - name: 配置Python环境
        uses: actions/setup-python@v5
        with:
          python-version: '3.11'  # 选择适配Pyvis的Python版本

      - name: 安装依赖
        run: |
          python -m pip install --upgrade pip
          pip install pyvis

      - name: 生成可视化HTML
        run: python your_script_name.py  # 替换为你的Python脚本文件名（如main.py）

      - name: 部署到GitHub Pages
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs  # 对应脚本输出的目录
          publish_branch: gh-pages  # 部署目标分支

步骤3：配置GitHub Pages仓库设置 #

1. 进入仓库的Settings页面
2. 找到Pages选项
3. 在Source区域，选择gh-pages分支，根目录（或/docs目录，根据你的偏好）
4. 保存设置

注意事项 #

• 确保Python脚本中的输出路径与工作流里的publish_dir一致
• 工作流中的脚本文件名必须和仓库里的实际文件名匹配
• 首次部署后，GitHub Pages可能需要几分钟才能生效

内容的提问来源于stack exchange，提问作者pmalys