iT邦幫忙

2

自動更新 GitHub Profile README 中的 IT 邦幫忙文章

  • 分享至 

  • xImage
  •  

最近剛好在做自己github的profile readme
剛好想到可以抓取之前寫的it邦幫忙鐵人賽文章放進readme
看到github action marketplace好像沒有
就自己寫了一個github action 放到marketplace上
Github Action MarketPlace: https://github.com/marketplace/actions/ithome-article-post-action
專案連結: https://github.com/Charonyuu/ithome_blog_upload

如何使用

  1. 到想要使用的專案 repository
  2. 將以下內容放入你想要使用的 readme 中,github action 會將 blog post 自動更新到這個位置中間。
<!-- ITHOME-POST-LIST:START -->
<!-- ITHOME-POST-LIST:END -->
  1. 新增.github 資料夾,再新增workflows資料夾,如果之前沒有建立過,就要先建立。
  2. workflows 資料夾中新增檔案ithome-post-update.yml:
name: Latest ithome blog update workflow

on:
  schedule:
    # 自動更新時間
    - cron: "0 * * * *" # 每小時更新(可以自動更新)
  workflow_dispatch: # 手動更新

permissions:
  contents: write # 讀寫權限

jobs:
  update-readme-with-blog:
    name: Update this repo's README with latest blog posts
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Ithome Article Post Action
        uses: Charonyuu/ithome_blog_upload@master
        with:
          ghToken: ${{ secrets.GITHUB_TOKEN }}
          userId: "20162289"
          like: "false"
          comment: "false"
  1. 替換掉 userId 變成自己 ithome 的 id.範例如下
    查詢it幫幫忙id圖片
  2. 到專案 repository settings, 點選左側的 Actions > General. 更新 "Workflow permissions"變成 "Read and write permissions"然後儲存
    workflow pemission圖片

7.結果演示:
https://ithelp.ithome.com.tw/upload/images/20240423/20162289OsGRuqYtvS.png

有一些參數可以調整,例如:要不要顯示留言或文章擷取數量或者修改action的commiter

Workflow 選項 預設值 說明 必填
userId "" 你的 it 幫幫忙 id yes
gh_token ${{ secrets.GITHUB_TOKEN }} 你的 GitHub token,用來更新 readme yes
limit 5 設定要抓幾個 post yes
like true 是否要顯示喜歡數 no
comment true 是否要顯示留言數 no
view true 是否要顯示閱讀數 no
commit_message Updated with the latest ithome blog posts 自動更新時 commit message no
committer_username ithome-blog-upload-readme-bot 自動更新時 committer username no
committer_email ithome-blog-upload-readme-bot@example.com 自動更新時 committer email no
icon_emoji false 是否要用 emoji 圖示顯示觀看喜歡與評論數 👍💬👁️ no

謝謝看完~/images/emoticon/emoticon41.gif

如果有幫助的話 歡迎幫我按個星星
https://github.com/marketplace/actions/ithome-article-post-action
如果也想要抓取其他網站自己的文章 也歡迎fork下來改變數
https://github.com/Charonyuu/ithome_blog_upload
有什麼建議也可以開issue或留言跟我說(第一次發文手下留情)


圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言