README-Scribe 使用教程

README-Scribe 使用教程

readme-scribe A GitHub Action that automatically generates & updates markdown content (like your README.md) 项目地址: https://gitcode.com/gh_mirrors/re/readme-scribe

1. 项目目录结构及介绍

README-Scribe 是一个GitHub Action，用于自动生成和更新Markdown内容，例如你的 README.md 文件。以下是项目的目录结构：

readme-scribe/
├── .github/
│   ├── workflows/
│   │   └── readme-scribe.yml  # GitHub 工作流文件
├── assets/
│   └── ...                     # 额外的资源文件
├── test/
│   └── ...                     # 测试文件
├── LICENSE                     # 项目许可证文件
├── README.md                   # 项目自述文件
└── templates/
    └── README.md.tpl           # README 模板文件

• .github/workflows/: 存放GitHub工作流文件，用于定义自动化任务。
• assets/: 存放项目所需的资源文件。
• test/: 存放测试文件，用于确保代码质量。
• LICENSE: MIT许可证文件，定义了项目的使用和分发条款。
• README.md: 项目的自述文件，介绍了项目的功能和用法。
• templates/: 存放用于生成README的模板文件。

2. 项目的启动文件介绍

项目的启动是通过 .github/workflows/readme-scribe.yml 文件定义的。这是一个GitHub工作流文件，用于设置自动执行的任务。以下是启动文件的示例内容：

name: Update README

on:
  push:
  schedule:
    - cron: "0 */1 * * *"

jobs:
  markscribe:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - uses: muesli/readme-scribe@master
        env:
          GITHUB_TOKEN: "${{ secrets.PERSONAL_GITHUB_TOKEN }}"
        with:
          template: "templates/README.md.tpl"
          writeTo: "README.md"
      - uses: stefanzweifel/git-auto-commit-action@v4
        env:
          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
        with:
          commit_message: "Update generated README"
          branch: main
          commit_user_name: "readme-scribe 🤖"
          commit_user_email: "actions@github.com"
          commit_author: "readme-scribe 🤖 <actions@github.com>"

此文件定义了一个名为 Update README 的工作流，它将在每次代码推送或定时任务触发时自动更新README文件。

3. 项目的配置文件介绍

项目的配置主要通过工作流文件中的 env 环境变量和 with 选项进行设置。以下是一些关键配置的介绍：

• GITHUB_TOKEN: 用于验证和授权GitHub操作的token。
• template: 指定用于生成README的模板文件路径。
• writeTo: 指定生成的Markdown文件将保存的路径。

你需要在项目的Settings中创建一个名为 PERSONAL_GITHUB_TOKEN 的秘密，并将其设置为你的GitHub个人访问token。确保token具有必要的API作用域，以便正确执行操作。

以上是README-Scribe项目的目录结构、启动文件和配置文件的详细介绍。通过这些信息，你可以开始配置和使用README-Scribe来自动化你的Markdown内容生成。

readme-scribe A GitHub Action that automatically generates & updates markdown content (like your README.md) 项目地址: https://gitcode.com/gh_mirrors/re/readme-scribe