Skip to content

[第 61 期]开源项目自荐: Github-Issue博客仓库集成Circle-CI, 自动更新README #585

@jwenjian

Description

@jwenjian

现在很多人, 包括我, 在折腾了一堆个人博客的系统之后, 放弃了花哨的页面效果, 回过头来用Github Issue写博客.

但头疼的一点就是:
如果让其他人直接点到自己仓库的issues页面来看自己的文章的话, 只会看到issue的列表, 没有突出内容, 没有分类, 没有about me, 只有一条条的issue.

如果想解决上述的问题, 就要手动在发布issue之后, 手动更新README, 并且push到仓库, 那么你需要:

  • 一台电脑
  • 安装git
  • clone仓库
  • 修改README
  • push

很麻烦, 感觉慢慢没有了更新的动力 😢

基于这个痛点, 我找到了一个办法:
利用Circle CI提供的定时任务功能, 结合GitHub的API来实现:

  1. 通过Github API获取当前仓库的信息, 如
  • 总issue数量
  • 总label数量
  • 每个label下的issues列表
  • 最新更新(创建)的是哪些issue
  1. 将这些信息组装出自己满意的README页面
  2. 更新仓库的README.md文件
  3. 提交README.md的变更到远程仓库, 到这里, 我们的痛点就解决了一半, 剩下就是将步骤1-4每天自动执行
  4. 集成Circle-CI, 创建定时任务, 指定cron表达式为0 0 * * *, 这样, 每天0点的时候, Circle-CI就会执行1-4的步骤!

于是, 你只需要写Issue就好了, 剩下的交给Circle-CI就好了.

🎉

参考我的ghiblog仓库: https://github.com/jwenjian/ghiblog

截图:

这个README是自动生成且提交到github的.

image

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions