本文已参与「新人创作礼」活动，一起开启掘金创作之路。

我们会经常在开源项目中看到有很多人贡献了代码，那如何在 README.md 中如何去体现呢？如果一个个的去自己手动写的，显然不现实。本文给大家推荐一款自动生成贡献者的action - contributors-readme-action ，彻底解放我们的双手。

配置

首先在项目根目录下创建 .github/workflows 目录，GitHub 会自动找到该目录下的所有事件进行执行。

然后在 workflows 下创建 reademe-contributors.yml 文件，用于编写 action 脚本。

# 监听 master 分支
on:
  push:
    branches:
      - master

# action 名称
name: Contributes

jobs:
  # 任务
  contrib-readme-en-job:
    runs-on: ubuntu-latest
    name: A job to automate contrib in readme
    steps:
      - name: Contribute List
        uses: akhilmhdh/contributors-readme-action@v2.3.4
        env:
          GITHUB_TOKEN: ${{ secrets.CONTRIBUTORS_TOKEN }}

secrets 为 GitHub 提供的变量空间，我们需要设置 CONTRIBUTORS_TOKEN 变量，用于存放某些特定的权限 Token，当然这个变量名称是随意的。

生成 Token

脚本编写完成之后，我们需要配置 CONTRIBUTORS_TOKEN 这个变量，确保 contributors-readme-action 有对应的权限进行一些必要的修改和更新。

1649748199(1).png

首先进入到设置页面，找到 Developer settings 中的 Personal access tokens，然后点击 Generate new token 进行新增。

Note 可以随意填写，不需要与 action 配置的 CONTRIBUTORS_TOKEN 一样，这里我们填 contributors-test

Expiration 设置不过期 No expiration，然后勾选以下权限

最后点击 Generate token，即可生成对应 Token，然后点击复制按钮进行复制。

注意：该页面关闭之后，如果没有复制或者保存的话，token将会消失，只能重新执行上述步骤重新生成。

生成 CONTRIBUTORS_TOKEN

接下来，需要到项目中的 Settings 去配置 CONTRIBUTORS_TOKEN

点击 New repostory secret，Name 需要与 action 中的 secrets.xxx 一致，Value 的话就是我们上一步生成出来的 Token，直接粘贴即可。

之后点击 Add secret 即可生成 CONTRIBUTORS_TOKEN

配置生成位置

当我们配置好之后，需要在你需要生成贡献者列表的文件中，假设我们在 README.md 中，添加以下代码， ## 合作者 与 贡献者 标题可根据需要自行修改。

## 贡献者

<!-- readme: collaborators,contributors -start -->
<!-- readme: collaborators,contributors -end -->

然后，当我们代码 push 到 master 分支的时候，就会自动触发该 action，然后生成对应的贡献者列表。

1649751581(1).png

最后，我们就可以在 README.md 中看到已经自动帮我们生成出了贡献者列表了。

1649751897(1).png

总结

本文只是展示了 contributors-readme-action 比较基础的用法，如果需要更多复杂配置的话，可以查看文档

如果需要文章的源码，可自取：文章项目Demo

GitHub Action - 自动生成贡献者列表

配置

生成 Token

生成 CONTRIBUTORS_TOKEN

配置生成位置

总结