https://github.com/djdefi/team-readme-generator

GitHub Action for updating a repository readme with a table of team members
https://github.com/djdefi/team-readme-generator

github-actions readme-generator team-members

Last synced: 13 days ago
JSON representation

GitHub Action for updating a repository readme with a table of team members

• Host: GitHub
• URL: https://github.com/djdefi/team-readme-generator
• Owner: djdefi
• Created: 2022-10-12T23:05:28.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-05T19:50:04.000Z (7 months ago)
• Last Synced: 2024-10-14T02:47:42.161Z (24 days ago)
• Topics: github-actions, readme-generator, team-members
• Homepage:
• Size: 83 KB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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

    ```yaml

    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 }}

    ```

1. Setup the README.md by adding the following two tags wherever you want the table to appear:

    ```markdown

    

    

    ```

1. 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.

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

1. Review and merge the resulting pull requests.