开源项目 `blog-post-workflow` 使用教程

开源项目 blog-post-workflow 使用教程

blog-post-workflow Show your latest blog posts from any sources or StackOverflow activity or Youtube Videos on your GitHub profile/project readme automatically using the RSS feed 项目地址: https://gitcode.com/gh_mirrors/bl/blog-post-workflow

1. 项目的目录结构及介绍

blog-post-workflow/
├── .github/
│   └── workflows/
│       └── blog-post-workflow.yml
├── README.md
└── LICENSE

• .github/workflows/: 包含GitHub Actions的工作流配置文件，用于自动更新README.md文件。
• README.md: 项目的说明文档，包含项目的基本信息和使用方法。
• LICENSE: 项目的开源许可证文件。

2. 项目的启动文件介绍

项目的主要启动文件是 .github/workflows/blog-post-workflow.yml。该文件定义了GitHub Actions的工作流，用于自动从指定的RSS源获取最新的博客文章，并更新到项目的README.md文件中。

blog-post-workflow.yml 文件内容

name: Latest blog post workflow

on:
  schedule:
    - cron: '0 * * * *'  # 每小时运行一次
  workflow_dispatch:  # 允许手动触发工作流

permissions:
  contents: write  # 允许写入README.md文件

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: Pull in dev.to posts
        uses: gautamkrishnar/blog-post-workflow@v1
        with:
          feed_list: "https://dev.to/feed/gautamkrishnar https://www.gautamkrishnar.com/feed/"

文件功能介绍

• name: 工作流的名称。
• on: 定义工作流的触发条件，包括定时触发和手动触发。
• permissions: 设置工作流的权限，允许写入仓库内容。
• jobs: 定义工作流的具体任务，包括更新README.md文件。
• steps: 工作流的具体步骤，包括检出代码和拉取最新的博客文章。

3. 项目的配置文件介绍

项目的配置文件主要是 .github/workflows/blog-post-workflow.yml。该文件中包含了以下关键配置项：

• feed_list: 指定RSS源的URL列表，用于获取最新的博客文章。
• cron: 定义工作流的定时触发规则，这里是每小时运行一次。
• permissions: 设置工作流的权限，允许写入仓库内容。

通过这些配置，项目可以自动从指定的RSS源获取最新的博客文章，并更新到README.md文件中。

blog-post-workflow Show your latest blog posts from any sources or StackOverflow activity or Youtube Videos on your GitHub profile/project readme automatically using the RSS feed 项目地址: https://gitcode.com/gh_mirrors/bl/blog-post-workflow