github-metrics-工具盒子

坚强的信念能赢得强者的心，并使他们变得更坚强。 ------白哲特

最近在探索如何通过 GitHub Actions 自动生成个性化的 GitHub 个人主页统计数据时，发现了一个非常强大的工具 ------ Metrics 。这个工具由开源开发者 lowlighter 创建，能够根据你的 GitHub 数据生成多种可视化的统计图表，并将其集成到你的 README 文件中。它不仅可以展示代码提交记录、仓库概览，还支持各种第三方平台的扩展数据，比如 Spotify、Wakatime、RSS 等，让你的个人主页变得更加丰富和有趣。

什么是 Metrics？ {#什么是-metrics}

Metrics 是一个基于 GitHub Actions 的自动化工具，它通过访问 GitHub API 获取用户的数据，并生成个性化的统计图表。这些图表可以直接嵌入到你的 GitHub 个人主页的 README 文件中。它支持多种插件和模块，你可以根据自己的需求自定义统计内容。

使用 Metrics 的主要步骤包括设置 GitHub Actions、生成配置文件以及集成到 README 中。

如何使用 Metrics？ {#如何使用-metrics}

设置 GitHub Actions

首先，你需要在自己的 GitHub 仓库中启用 GitHub Actions。以下是具体的设置步骤：

在你的 GitHub 仓库中，进入 Actions 标签页。
点击 "New workflow" 或创建一个新的 .yml 文件，例如：.github/workflows/metrics.yml。
在这个文件中添加 Metrics 所需的配置代码。下面是一个基本的配置模板：

|---------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | hljs yml name: Generate Metrics on: schedule: - cron: '0 0 * * *' # 每天自动更新 workflow_dispatch: # 手动触发 push: branches: - main jobs: build: runs-on: ubuntu-latest steps: - name: Checkout repository uses: actions/checkout@v3 - name: Generate Metrics uses: lowlighter/metrics@latest with: token: ${{ secrets.METRICS_TOKEN }} config: metrics.config.yml |

创建配置文件

在仓库根目录下创建一个 metrics.config.yml 文件，这个文件用来定义生成图表的内容和样式。以下是一个简单的示例：

|-------------------|-------------------------------------------------------------------------------------------------------------------------------| | 1 2 3 4 5 | hljs yml user: your-github-username plugin_contributors: yes plugin_languages: yes plugin_stars: yes template: classic |

生成 Personal Access Token

由于 Metrics 需要访问 GitHub API，你需要生成一个 Personal Access Token 并将其添加到仓库的 Secrets 中。

前往 GitHub Developer Settings。
点击 "Generate new token" 并选择 repo 和 read:org 权限。
将生成的 Token 添加到仓库的 Settings > Secrets 中，命名为 METRICS_TOKEN。

运行 Workflow

完成上述设置后，你可以手动触发 Workflow，或者等待定时任务触发（如配置的 cron）。执行完成后，Metrics 会生成图表并将其推送到你的 README 文件中。

自定义图表 {#自定义图表}

Metrics 提供了许多插件，支持展示不同的数据类型，比如：

语言统计：展示你的代码主要使用的编程语言分布。
贡献者统计：展示参与过你项目的贡献者数据。
第三方数据：支持 Spotify 的当前播放内容、Wakatime 的编码时间统计等。

可以通过在 metrics.config.yml 中添加插件配置来启用这些功能。例如：

|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 1 2 3 4 5 6 7 8 9 | hljs yml plugin_languages: enabled: yes threshold: 2% plugin_wakatime: enabled: yes token: your-wakatime-token plugin_spotify: enabled: yes token: your-spotify-token |