如何在 Github 个人资料上创建自动更新的 README
你好
👋
,我是 Codeperfectplus
我在Hacker News上发现了一篇名为《为 GitHub 构建一个自更新个人资料 README》的文章。我对这个GitHub新功能非常感兴趣,并想为我的 GitHub 个人资料构建一个类似的功能。
GitHub 个人资料自述文件
GitHub 个人资料 README 是一项新功能,允许用户在个人资料页面上呈现 README markdown 文件的内容。
要使用此功能,您只需创建一个与您的 GitHub 帐户同名的新仓库。我的仓库位于github.com/mokkapps/mokkapps
。此仓库需要公开,并使用 README 文件进行初始化:
现在,您将在个人资料页面顶部看到一个新部分,其中呈现此新 README 文件的内容:
在我的示例中,我显示了五个指向我网站上最新博客文章和我在 Twitter 上发布的最新推文的链接。这些信息会自动更新,我想向你展示我是如何实现此功能的。
自动更新 README
所有神奇的事情都发生在build.yml中定义的 GitHub Action 中。此操作在每次 Git 推送时运行,或者每整点 32 分钟运行一次(通过 cron 计划配置),或者通过手动点击 GitHub Action UI 中的按钮(通过使用workflow_dispatch
事件)运行。
工作流执行以下操作:
- 使用 Twitter API 从我的 Twitter 帐户获取最新推文,使用无头 Chrome(来自 R 脚本)将其呈现为 PNG,然后将其保存为 PNG,然后嵌入到 README 中(取自zhiiiiyang)。
- 运行 JavaScript 脚本,从我的 RSS 源中获取五篇最新的博客文章并生成最终的
README.md
(受simonw启发) - 提交并将更改推送到此仓库的主分支
JS 脚本非常简单,只有~50 行代码。
结论
GitHub 个人资料 README 是一个很酷的功能,通过使用 GitHub Actions,它可以帮助我们为个人资料访问者提供最新信息。
但最重要的是,我在建造它的过程中获得了很大的乐趣,这比其他一切都重要。
文章来源:https://dev.to/mokkaapps/how-i-built-a-self-updating-readme-on-my-github-profile-418d