使用 GitHub Actions 对 GitHub Profile 个人主页进行自动更新

实际效果

先看效果 https://github.com/88250

image.png

红框部分是通过 GitHub Actions 自动更新的,内容来源由社区 API 获取用户近期动态列表提供。当有人 Star 我的个人主页仓库 https://github.com/88250/88250 时就会触发该 GitHub Action 从而完成 README.md 的自动更新,最终在个人主页页面就可以看到以上效果了。

代码实现

最新代码请以我仓库实际代码为准,以下代码仅为了说明原理。

Action 配置如下:

name: Update events

on:
  watch:
    types: started

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - name: Check out repo
      uses: actions/checkout@v2
    - uses: actions/setup-go@v2
    - name: Fetch events
      run: go run main.go
    - name: Commit and push
      run: |-
        git config --global user.email "bot@github.com" && git config --global user.name "Bot"
        git diff
        git add . && git commit -m ":memo: 更新自述" || exit 0
        git push        

除了 Star 触发,也可以有其他触发方式,比如代码提交、外部接口或者定时等,具体可参考 Events that trigger workflows

主要逻辑是通过 golang 实现,获取数据并更新 README.md 文件,该程序代码如下:

package main

import (
	"bytes"
	"crypto/tls"
	"fmt"
	"io/ioutil"
	"net/http"
	"os"
	"time"

	"github.com/88250/gulu"
	"github.com/parnurzeal/gorequest"
)

var logger = gulu.Log.NewLogger(os.Stdout)

const (
	githubUserName = "88250"
	hacpaiUserName = "88250"
)

func main() {
	result := map[string]interface{}{}
	response, data, errors := gorequest.New().TLSClientConfig(&tls.Config{InsecureSkipVerify: true}).
		Get("https://hacpai.com/api/v2/user/"+hacpaiUserName+"/events?size=8").Timeout(7*time.Second).
		Set("User-Agent", "Profile Bot; +https://github.com/"+githubUserName+"/"+githubUserName).EndStruct(&result)
	if nil != errors || http.StatusOK != response.StatusCode {
		logger.Fatalf("fetch events failed: %+v, %s", errors, data)
	}
	if 0 != result["code"].(float64) {
		logger.Fatalf("fetch events failed: %s", data)
	}

	buf := &bytes.Buffer{}
	buf.WriteString("\n\n")
	updated := time.Now().Format("2006-01-02 15:04:05")
	buf.WriteString("我的近期动态(点个 [Star](https://github.com/" + githubUserName + "/" + githubUserName + ") 将触发自动刷新,最近更新时间:`" + updated + "`):\n\n")
	for _, event := range result["data"].([]interface{}) {
		evt := event.(map[string]interface{})
		operation := evt["operation"].(string)
		title := evt["title"].(string)
		url := evt["url"].(string)
		content := evt["content"].(string)
		buf.WriteString("* [" + operation + "](" + url + "):(" + title + ")" + content + "\n")
	}
	buf.WriteString("\n")

	fmt.Println(buf.String())

	readme, err := ioutil.ReadFile("README.md")
	if nil != err {
		logger.Fatalf("read README.md failed: %s", data)
	}

	startFlag := []byte("<!--events start -->")
	beforeStart := readme[:bytes.Index(readme, startFlag)+len(startFlag)]
	newBeforeStart := make([]byte, len(beforeStart))
	copy(newBeforeStart, beforeStart)
	endFlag := []byte("<!--events end -->")
	afterEnd := readme[bytes.Index(readme, endFlag):]
	newAfterEnd := make([]byte, len(afterEnd))
	copy(newAfterEnd, afterEnd)
	newReadme := append(newBeforeStart, buf.Bytes()...)
	newReadme = append(newReadme, newAfterEnd...)
	if err := ioutil.WriteFile("README.md", newReadme, 0644); nil != err {
		logger.Fatalf("write README.md failed: %s", data)
	}
}

大家也可以用上

如果你也想将社区动态放到 GitHub 个人主页上,可以 Fork 我的仓库,然后:

  1. 修改 README.md,将内容改为自己的,<!--events start --><!--events end --> 中间留空,大概就是这样:

    ...
    你的 README 主体内容
    ...
    <!--events start -->
    <!--events end -->
    
  2. 修改 main.go 中 githubUserNamehacpaiUserName 常量,都改为对应的用户名

  3. 提交代码推送仓库

然后自己点下 Star 测试看看,可以在自己仓库的 Actions 上看到执行过程输出(我的实例),如果有报错的话请跟帖反馈。

Just for fun trollface

  • GitHub

    GitHub 于 2008 年上线,目前,除了 Git 代码仓库托管及基本的 Web 管理界面以外,还提供了订阅、讨论组、文本渲染、在线文件编辑器、协作图谱(报表)、代码片段分享(Gist)等功能。正因为这些功能所提供的便利,又经过长期的积累,GitHub 的用户活跃度很高,在开源世界里享有深远的声望,并形成了社交化编程文化(Social Coding)。

    180 引用 • 1902 回帖 • 356 关注

赞助商 我要投放

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...
  • telami
    捐赠者

    为啥要移除超链接啊,为啥总是逆着用户习惯呢?
    从主页进来有时候 URL 会有 comment 标记,以前可以点击标题让评论恢复正确的时间线,从头到尾看看讨论的始末,现在要翻到最后面,点查看全部,或者是在 url 删掉后面多余的参数,来实现原来点击标题的功能

    D 大,下线新功能,可不可以开一个讨论帖,大家投票决定一下,每一个下线的功能不该听一下用户的声音么

    1 回复
  • 其他回帖
  • 88250
    作者

    感谢领导的肯定 wulian

  • Ahian 1 赞同

    嘻嘻

    image.png

    1 操作
    Ahian 在 2020-07-21 22:16:32 更新了该回帖
  • 88250
    作者

    抱歉了,稍后我们再改进一下,让大家可以方便点击回到帖子详情。标题上去掉超链接主要是因为复制问题,复制标题会带链接格式,有用户反馈很不方便所以去掉了,期间也参考了下 GitHub Issue,它也是这样用的纯文本,所以就改进了一下。

  • 查看全部回帖