markyin0707 / social-readme

在你的GitHub主页中展示你最近的博客文章和豆瓣动态、自动构建社交feed流。

social-readme

Automatically build Social feeds in your Profile Readme everyday, preview: github.com/zylele

每天自动构建社交feed到你的主页readme中，预览：github.com/zylele

目前支持

• rss，符合rss2.0或atom标准，比如 我的博客 rss链接是https://zylele.github.io/atom.xml
• 豆瓣（想看、在看和看过的书和电影，想听、在听和听过的音乐）

更新你的项目readme

根据你的需要，在你的readme中增加以下内容

博客:

<!-- START_SECTION:blog -->
<!-- END_SECTION:blog -->

豆瓣:

<!-- START_SECTION:douban -->
<!-- END_SECTION:douban -->

这些是构建feed信息的识别点

Profile Repository(<username>/<username>)

仓库名与你的GitHub用户名相同的，就是Profile Repository

这是GitHub的一个彩蛋，仓库根目录的README.md文件将会被渲染展示在你的个人公共主页上

比如我的Profile Repository是 github.com/zylele/zylele ，README.md将会展示在我的主页上：zylele(Ale)

如果你在Profile Repository上构建workflow

那你就不需要GitHub Access Token，因为GitHub Action已经为你生成了一个

• 在你项目的根目录，新建.github/workflows/social-readme.yml，或者编辑其他已有的workflow文件

• 拷贝以下代码到上一步的文件中，根据你的需要，选填博客atom链接blog_rss_link，豆瓣用户名douban_name（豆瓣个人主页地址可以看到douban.com/people/username/）

name: Social Readme

on:
  schedule:
    - cron: '0 0 * * *'
  workflow_dispatch:
  push:
    branches:
      - master

jobs:
  update-social:
    runs-on: ubuntu-latest
    steps:
      - uses: zylele/social-readme@master
        with:
          blog_rss_link: your blog rss link
          douban_name: your douban username

其他仓库（not <username>/<username>）

如果你在其他仓库构建workflow

那你需要先获取GitHub Access Token 并且保存在Repo Secrets GH_TOKEN = <Your GitHub Access Token>

下面是运行它的示例workflow文件：

name: Social Readme

on:
  schedule:
    - cron: '0 0 * * *'
  workflow_dispatch:
  push:
    branches:
      - master

jobs:
  update-social:
    runs-on: ubuntu-latest
    steps:
      - uses: zylele/social-readme@master
        with:
          blog_rss_link: your blog rss link
          douban_name: your douban username
          gh_token: ${{ secrets.GH_TOKEN }}
          repository: <username/reponame> #可选，默认将会自动使用执行workflow的存储库

可选配置

如果你想定制更多构建细节，在workflow文件中的with有如下可选参数

- uses: zylele/social-readme@master
  with:
    blog_rss_link: your blog rss link
    blog_limit: 5 # blog数量
    douban_name: your douban username
    douban_limit: 5 # 豆瓣最新动态数量
    commit_message: Updated social rss by social-readme # commit说明