GitHub Profile Summary Cards 项目部署教程

项目概述

GitHub Profile Summary Cards 是一个能够为开发者生成精美个人资料摘要卡片的工具。这些卡片可以展示你的代码贡献、项目活跃度等关键信息，并以可视化方式呈现在个人主页上。

准备工作

1. 生成访问令牌

首先需要创建一个具有适当权限的访问令牌：

1. 进入账户设置 -> 开发者设置 -> 个人访问令牌
2. 创建新令牌并命名为"profile-summary-cards-token"
3. 确保勾选以下权限：
   • Repo相关：
     • repo:status
     • repo_deployment
     • public_repo
   • User相关：
     • read:user
     • user:email
4. 生成后妥善保存令牌（丢失后需要重新生成）

项目部署

2. 选择代码仓库

有两种部署方式可选：

方式一：创建新仓库（推荐新手）

1. 使用项目提供的模板创建新仓库
2. 将仓库命名为你的用户名（格式为：用户名/用户名）
3. 这样会自动创建个人主页展示所需的特殊仓库

方式二：使用现有仓库

1. 确保仓库中有README.md文件
2. 将仓库重命名为你的用户名格式
3. 这样可以在保留原有内容的基础上添加卡片

3. 创建工作流

1. 进入仓库的Actions选项卡
2. 选择"新建工作流" -> "自行设置工作流"
3. 命名为"profile-summary-cards.yml"
4. 使用以下配置代码：

name: GitHub-Profile-Summary-Cards

on:
    create:
    schedule: # 每24小时执行一次
      - cron: "* */24 * * *"
    workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    name: generate-github-cards
    permissions:
      contents: write

    steps:
      - uses: actions/checkout@v2
      - uses: vn7n24fzkq/github-profile-summary-cards@release
        env:
          GITHUB_TOKEN: ${{ secrets.[YOUR_SECRET_TOKEN_NAME] }}
        with:
          USERNAME: ${{ github.repository_owner }}

4. 配置定时任务

工作流默认每24小时运行一次，如需调整：

• 每15小时运行："* */15 * * *"
• 每周五12:35运行："35 12 * * fri"

Cron表达式格式说明：

# .---------------- 分钟 (0 - 59)
# |  .------------- 小时 (0 - 23)
# |  |  .---------- 日期 (1 - 31)
# |  |  |  .------- 月份 (1 - 12)
# |  |  |  |  .---- 星期 (0 - 6) (0=周日)
# |  |  |  |  |
# *  *  *  *  * 

5. 设置令牌密钥

1. 进入仓库设置 -> Secrets -> Actions
2. 添加新仓库密钥，名称建议为"summary_card_token"
3. 粘贴之前生成的个人访问令牌
4. 记录下密钥名称供后续使用

6. 编辑工作流文件

1. 返回代码仓库中的工作流文件
2. 将[YOUR_SECRET_TOKEN_NAME]替换为实际的密钥名称
3. 提交更改

7. 运行工作流

1. 进入Actions选项卡
2. 找到"profile-summary-cards"工作流
3. 手动触发运行
4. 等待执行完成（蓝色对勾表示成功）

最终配置

1. 进入生成的卡片输出目录
2. 选择喜欢的主题样式
3. 复制对应的Markdown代码
4. 粘贴到仓库的README.md文件中
5. 提交更改

常见问题

1. 工作流卡住：尝试刷新页面
2. 执行失败：检查令牌权限是否正确
3. 卡片不显示：确认仓库命名格式是否正确

个性化建议

项目提供多种主题样式可供选择，建议尝试不同布局找到最适合的展示方式。卡片内容会自动定期更新，保持个人主页信息的时效性。

通过本教程，你应该已经成功部署了个人资料摘要卡片系统。这个工具能有效提升你的开发者个人主页的专业度和信息展示效果。