GitHub Activity Readme 项目教程

GitHub Activity Readme 项目教程

github-activity-readme Updates README with the recent GitHub activity of a user 项目地址: https://gitcode.com/gh_mirrors/gi/github-activity-readme

1. 项目介绍

github-activity-readme 是一个 GitHub Action，用于自动更新用户的 README 文件，展示用户最近的 GitHub 活动。这个项目可以帮助用户在他们的 GitHub 个人主页上动态展示最新的活动，如提交、PR、Issue 等。

2. 项目快速启动

2.1 安装步骤

1. 克隆项目：

   git clone https://github.com/jamesgeorge007/github-activity-readme.git
   cd github-activity-readme
   

2. 创建 GitHub Action 工作流： 在你的仓库中创建一个 .github/workflows/update-readme.yml 文件，并添加以下内容：

   name: Update README
   on:
     schedule:
       - cron: "*/30 * * * *"
     workflow_dispatch:
   jobs:
     build:
       name: Update this repo's README with recent activity
       runs-on: ubuntu-latest
       permissions:
         contents: write
       steps:
         - uses: actions/checkout@v3
         - uses: jamesgeorge007/github-activity-readme@master
           env:
             GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
   

3. 在 README 中添加标记： 在你的 README.md 文件中添加以下标记，用于指定活动更新的位置：

   <!--START_SECTION:activity-->
   <!--END_SECTION:activity-->
   

2.2 配置参数

你可以通过以下参数自定义 GitHub Action 的行为：

• GH_USERNAME：GitHub 用户名（默认是当前仓库的所有者）
• COMMIT_NAME：提交者的名字（默认是 github-actions[bot]）
• COMMIT_EMAIL：提交者的邮箱（默认是 41898282+github-actions[bot]@users.noreply.github.com）
• COMMIT_MSG：提交消息（默认是 ⚡ Update README with the recent activity）
• MAX_LINES：README 中显示的最大活动行数（默认是 5）
• TARGET_FILE：目标文件（默认是 README.md）

3. 应用案例和最佳实践

3.1 应用案例

• 个人主页动态更新：用户可以在自己的 GitHub 个人主页上展示最近的代码提交、PR、Issue 等活动。
• 开源项目维护：项目维护者可以通过此 Action 自动更新项目 README，展示最新的社区活动。

3.2 最佳实践

• 定期更新：通过设置 cron 表达式，定期更新 README 文件，保持活动信息的实时性。
• 自定义提交信息：根据需要自定义提交信息，方便后续追踪和管理。
• 限制活动行数：通过设置 MAX_LINES 参数，控制 README 中显示的活动数量，避免信息过载。

4. 典型生态项目

• GitHub Actions：github-activity-readme 是基于 GitHub Actions 构建的，可以与其他 GitHub Actions 结合使用，实现更复杂的自动化任务。
• JasonEtco/activity-box：这是一个类似的 GitHub Action，用于在 README 中展示用户的 GitHub 活动。
• GitHub Sponsors：通过 GitHub Sponsors 支持开源开发者，帮助他们持续维护和改进开源项目。

通过以上步骤，你可以轻松地在 GitHub 上展示你的最新活动，提升个人或项目的可见性和活跃度。

github-activity-readme Updates README with the recent GitHub activity of a user 项目地址: https://gitcode.com/gh_mirrors/gi/github-activity-readme