Skip to content

Team member table README updater

Actions
This Action opens a PR to update the README.md file with a table of team members
v2
Latest
Star (1)

team-readme-generator

Action to automatically keep a table of team members up to date in a repository README.

Example:

The Team:

👤 Username Location Bio
@djdefi California Staff Support Engineer @github
@bevns California Software Engineer

About us

We are small but mighty!

Usage:

  1. Configure a workflow such as the example

    name: "Team README table generator"
    
    on:
    
      # Allows you to run this workflow manually from the Actions tab
      workflow_dispatch:
        inputs:
          org:
            description: 'The organization to run the workflow against'
            required: true
            default: 'my-org'
          team:
            description: 'The team to run the workflow against'
            required: true
            default: 'my-team'
    
    jobs:
      run_team_readme_job:
        runs-on: ubuntu-latest
        name: Run team readme generator
        steps:
          - uses: actions/checkout@v3
          - id: Generate
            uses: djdefi/team-readme-generator@main
            with:
              org: ${{ github.event.inputs.org }}
              team: ${{ github.event.inputs.team }}
              my-pat: ${{ secrets.MY_PAT }}
    
  2. Setup the README.md by adding the following two tags wherever you want the table to appear:

    <!--auto-team-table-->
    <!--/auto-team-table-->
  3. Configure MY_PAT as an Actions secret. The token needs to have org:read and repo:write scopes to get team info and create pull requests.

  4. Run the the Action workflow with the desired team name.

  5. Review and merge the resulting pull requests.

Team member table README updater is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

This Action opens a PR to update the README.md file with a table of team members
v2
Latest

Team member table README updater is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.