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

实际效果

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

红框部分是通过 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 中 githubUserName 和 hacpaiUserName 常量，都改为对应的用户名

3. 提交代码推送仓库

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

Just for fun