如何使用 GitHub Star History 查看开源项目

为什么要使用它

当选择去使用一个工具（尤其是开源的）时，你的思考过程是怎么样的？对你来说，有哪些因素是重要的？

- 有其他用户吗？
- 它是这个类别中最受欢迎的吗？
- 这种技术是否在衰退？

这里有一个明显的衡量标准，我相信你也会调查：它的 GitHub 星星数。

我们知道，你不能只相信一个项目的 GitHub 星星数。但不可否认，如果你正确地使用它，它会是一个很好的指标来确定一个工具是否足够成熟并在维护和不断改进。

即使一个项目现在有数以亿计的星星数，并不意味着它仍然在继续获得人气和被维护。或者说，该项目只是在过去某一时间有一个爆炸性的突破？仅仅通过星星的数量，是无法知道这些的。这个时候，就该 Star History 登场了：它显示了一个项目在 GitHub 上的星星数量是如何逐年增加。而且它完全免费和开源！

用户手册

这只是一个简单的搜索框，能有多难？简洁确实是这个产品第一设计原则。另一方面，它也为高级用户提供了一些方便的功能。下面我们将向你展示。

一）如何使用 3 种不同的格式来添加一个仓库。
二）如何添加多个软件仓库。
三）如何调整时间线以比较多个仓库。
四）如何在图表中临时性地显示/隐藏一个 repo。
五）如何添加你的 GitHub 个人访问 Token 以消除 GitHub API 限制。
六）如何在你的 GitHub 项目的 README.md 中嵌入一个实时星形历史图表。
七）别忘了，我们还有一个 chrome 扩展。

一）如何使用 3 种不同的格式来添加一个仓库。

1. 把它的整个URL粘贴在搜索栏中。例如：https://github.com/star-history/star-history

2. 如果你觉得自己很懒，可以跳过 https://github.com/。例如：star-history/star-history
3. 当仓库的名称与组织的名称一致时，写一次就够了。例如：star-history 然而，对于像 hashicorp/terraform 这样的东西，你不能写 hashicorp 或 terraform，因为它们不一致。

二）如何添加多个仓库。

在添加一个仓库之后，你可以继续添加。这些仓库会呈现在同一个图表内。

例如，如果你想知道使用哪种 CI 工具，这里有它们的发展历史。Jenkins 很早就开始了，并保持着它的受欢迎程度，但后来 Drone 迅速取代了它。从这个陡峭的斜坡上，我们也可以看到 Argo 正在迅速追赶，尽管它是较新的项目之一。

三）如何对其时间线以比较多个仓库。

点击对齐时间线，图标将被重新渲染。

四）如何在图表中临时隐藏 / 显示一个仓库。

点击标签里表里的仓库名称可以改变它的可见性，而不是从图表中临时删除一个。

五）如何添加你的 GitHub 个人访问 Token 以消除 API 限制。

Star History 是免费使用的，但它使用 GitHub API 来获取仓库的元数据，这意味着你需要从 GitHub 添加你的个人访问 Token 才能开始使用 Star History。请放心，在这个过程中不需要任何个人数据。

1. 登录到你的 GitHub 账户，进入个人访问 Token 列表：
   https://github.com/settings/tokens
   。
2. 点击 Generate new token 生成新的 Token。

1. 点击 Generate new token（classic） 生成新的 Token（经典）。

1. 在 Token 详细信息页面上填写表格。

Note 批注：给它起个名字以便识别。
Expiration 过期时间：它的有效期是多长？
Select scopes 选择范围：这个 Token 的访问边界，对于 Star History 来说，仓库访问就可以了。

当你完成后，点击页面底部的 Generate Token 生成 Token。

1. 确保现在复制你的个人访问 Token。错过了你将不会再次看到它!

1. 回到 Star History，并点击 Edit Access 编辑访问 Token。粘贴该 Token。(这也是你将来编辑它的地方，当它过期，你需要生成一个新的。） 点击 Save 保存。

六）如何在你的 GitHub 项目 README.md 中嵌入实时 Star History 图表。

1. 点击图表下方的 Embed 嵌入。

1. 你需要先添加你的个人访问 Token，然后复制 iframe 代码片段并将其黏贴到你的 README.md 中。

七）Chrome 浏览器扩展

1. 访问
   https://chrome.google.com/webstore/detail/star-history/iijibbcdddbhokfepbblglfgdglnccfn
   ，根据指示安装。

1. 进入任何一个 GitHub 的仓库并点击浏览器上的扩展，你就能看到 Star History 图表。

---

你可以自己体验下并且告诉我们 @StarHistoryHQ 你的想法！

特别感谢 https://kajiblo.com/git-hub-star-history/ ， 为这篇文章提供了灵感。