GitHub Action
Team member table README updater
v2
Latest version
Action to automatically keep a table of team members up to date in a repository README.
👤 | Username | Location | Bio |
---|---|---|---|
@djdefi | California | Staff Support Engineer @github | |
@bevns | California | Software Engineer |
We are small but mighty!
-
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 }}
-
Setup the README.md by adding the following two tags wherever you want the table to appear:
<!--auto-team-table--> <!--/auto-team-table-->
-
Configure
MY_PAT
as an Actions secret. The token needs to haveorg:read
andrepo:write
scopes to get team info and create pull requests. -
Run the the Action workflow with the desired team name.
-
Review and merge the resulting pull requests.