返回

GitHub Action，助你轻松实现团队贡献者列表自动化生成！

前端

引言：项目贡献者的重要性

在一个项目的开发过程中，往往会有多名贡献者共同协作，每一位贡献者都为项目的成功做出了贡献。为了表彰和激励这些贡献者，在项目文档中列出他们的名字是很有必要的。这不仅可以让他们感受到自己的努力得到了认可，也有助于吸引更多的人加入项目，共同推进项目的发展。

方法一：手动维护贡献者列表

最传统的方法就是手动维护贡献者列表。这种方法虽然简单直接，但缺点也很明显：

  • 容易遗漏贡献者：在项目开发过程中，可能会加入新的贡献者，也可能会有人离开项目。如果手动维护贡献者列表，很容易遗漏这些变化，导致列表不准确。
  • 耗时耗力：随着项目的发展，贡献者数量会越来越多。手动维护贡献者列表会变得非常耗时耗力。

方法二：利用GitHub Action自动生成贡献者列表

GitHub Action是一种自动化工具，可以帮助你在GitHub上执行各种任务。你可以利用GitHub Action来自动生成贡献者列表。这种方法不仅可以避免手动维护的缺点，而且还能确保贡献者列表始终是最新的。

GitHub Action实现步骤

  1. 创建GitHub Action工作流文件

首先，你需要创建一个GitHub Action工作流文件。这个文件可以命名为.github/workflows/generate-contributors.yml。

name: Generate Contributors List

on:
  push:
    branches:
      - main

jobs:
  generate-contributors-list:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - run: |
        git log --format='%aN' | sort | uniq > contributors.txt
      - uses: EnricoMi/publish-markdown-action@master
        with:
          path: contributors.txt
          repository: ${{github.repository}}
          branch: contributors
  1. 配置GitHub Action工作流文件

在.github/workflows/generate-contributors.yml文件中，你需要配置以下内容：

  • name：工作流的名称。
  • on：触发工作流的事件。在本例中，工作流会在每次推送到main分支时触发。
  • jobs：工作流中的作业。在本例中，只有一个作业，名为generate-contributors-list。
  • runs-on：作业运行的环境。在本例中，作业将在ubuntu-latest环境中运行。
  • steps：作业中的步骤。在本例中，作业包含以下步骤：
    • uses: actions/checkout@v3：检出仓库的代码。
    • run: |：运行命令。在本例中，命令是git log --format='%aN' | sort | uniq > contributors.txt。此命令会将所有贡献者的名字提取出来，并输出到contributors.txt文件中。
    • uses: EnricoMi/publish-markdown-action@master：将contributors.txt文件发布到GitHub仓库中。
  1. 提交GitHub Action工作流文件

将.github/workflows/generate-contributors.yml文件提交到你的GitHub仓库中。

  1. 运行GitHub Action工作流

提交.github/workflows/generate-contributors.yml文件后，GitHub Action工作流就会自动运行。工作流运行完成后，你可以在仓库的contributors分支中找到contributors.txt文件。这个文件包含了所有贡献者的名字。

  1. 将贡献者列表添加到README.md文件中

最后，你可以将贡献者列表添加到你的README.md文件中。你可以使用以下Markdown语法：

## 贡献者

感谢以下贡献者对本项目的贡献：

- [贡献者1](https://github.com/贡献者1)
- [贡献者2](https://github.com/贡献者2)
- ...

结语：自动生成贡献者列表的好处

利用GitHub Action自动生成贡献者列表有很多好处：

  • 节省时间和精力： 你不再需要手动维护贡献者列表，可以节省大量的时间和精力。
  • 确保列表准确无误： GitHub Action可以自动提取贡献者信息，确保列表始终是最新的。
  • 彰显团队协作精神： 一个完整的贡献者列表可以彰显团队协作精神，激励团队成员继续为项目做出贡献。
  • 吸引更多贡献者： 一个完整的贡献者列表可以吸引更多的人加入项目，共同推进项目的发展。

行动起来，让GitHub Action为你自动生成贡献者列表吧！