GitHub Action
README Anime List
v1.0.0
Latest version
自動更新 README 追番列表的 GitHub Action 套件
首先要註冊一個 Bangumi 的帳號，然後複製現有的 README.md 到 template/README-eta.md，在想要放列表的地方貼上以下：
| 圖片 | 番劇 |
| --- | --- |
<% it.data.forEach(function (anime) { %>
|  | <%= anime.subject.name_cn %> |
<% }) %>
模板引擎是使用 eta，而可以使用的資料來源則是 Bangumi API 的 獲取用戶收藏，可以自行查詢可使用的資料。
這裡示範使用2欄的表格：
| 圖片 | 番劇 | 圖片 | 番劇 |
| --- | --- | --- | --- |
<% it.data.forEach(function (anime, index) { %><%= index % 2 == 0 ? '|' : '' %>  | <%= anime.subject.name_cn %> |<%= index % 2 == 1 ? '\n' : '' %><% }) %>
最後增加一個 workflow 檔：
.github/workflows/anime_list.yml
name: Update README
on:
push:
schedule:
- cron: '0 */1 * * *'
jobs:
anime_list:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: ycs77/readme-anime-list@main
with:
target: 'README.md'
template: 'template/README-eta.md'
bangumi_username: '715333'
bangumi_limit: 10
user_agent: 'ycs77/ycs77 README'
- name: Commit
uses: EndBug/add-and-commit@v4
with:
message: 'Update generated README'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
secrets.GITHUB_TOKEN不需要特別去增加，預設就會有的。
Required 目標 README 檔。
Required README 模板檔案。
Required Bangumi 用戶名稱或 uid。
預設值：10
列表項目數量。
預設值："ycs77/readme-anime-list"
給 Bangumi API 看的 User-Agent 值，參考：關於 User-Agent。
Under the MIT LICENSE