https://github.com/garnertb/get-team-members

This action fetches the users of a GitHub team.
https://github.com/garnertb/get-team-members

actions

Last synced: 22 days ago
JSON representation

This action fetches the users of a GitHub team.

• Host: GitHub
• URL: https://github.com/garnertb/get-team-members
• Owner: garnertb
• License: mit
• Created: 2022-07-07T16:08:47.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-08-06T14:45:38.000Z (over 1 year ago)
• Last Synced: 2024-10-05T09:03:37.693Z (about 1 month ago)
• Topics: actions
• Homepage:
• Size: 5.86 KB
• Stars: 2
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# get-team-members

This action fetches the users of a GitHub team.

## Usage

```yaml

- uses: garnertb/get-team-members@v1

  with:

    # Name of the organization that the team is a part of.

    # (required)

    org: ''

    # Name of the team to get the members of.

    # (required)

    team_slug: ''

    # The role to filter team members by.

    # Must be one of: 'member', 'maintainer', 'all'.

    # Default: 'all'

    role: ''

    # Personal access token (PAT) used to fetch team members. 

    # Note the PAT must be entitled to at least `read:org` scope.

    # Default: ${{ github.token }}

    token: ''

```

## Permissions

The GitHub [token][token docs] needs to have `read:org` permissions to read organizational team members.

## Scenerios

### Fetch handles for all members of a team

```yaml

- id: get-members

  uses: garnertb/get-team-members@v1

  with:

    org: garnertb-io

    team_slug: ops

    token: ${{ secrets.GITHUB_TOKEN }}

- run: "echo ${{ steps.get-members.outputs.members }}"

  shell: bash

```

### Fetch handles for the maintainers of a team

```yaml

- id: get-members

  uses: garnertb/get-team-members@v1

  with:

    org: garnertb-io

    team_slug: ops

    role: maintainer

    token: ${{ secrets.GITHUB_TOKEN }}

# print results

- run: "echo ${{ steps.get-members.outputs.members }}"

  shell: bash

```

### Access additional member properties

[Raw member data](https://docs.github.com/en/rest/teams/members#list-team-members) is accessible via the `data` output and can be manipulated with `jq`.

```yaml

- id: get-members

  uses: garnertb/get-team-members@v1

  with:

    org: garnertb-io

    team_slug: ops

    role: maintainer

    token: ${{ secrets.GITHUB_TOKEN }}

  - run: "echo '${{ steps.get-members.outputs.data }}' | jq '.[] | {login: .login, id: .id}'"

    shell: bash

```

Results:

```json

{

  "login": "garnertb",   

  "id": 1234

}

```

### Assign team members to issue

Use this action to set assignees for a new issue with [issue-bot](https://github.com/imjohnbo/issue-bot).

```yaml

- id: get-members

  uses: garnertb/get-team-members@v1

  with:

    org: garnertb-io

    team_slug: ops

    role: maintainer

    token: ${{ secrets.GITHUB_TOKEN }}

- name: Create new issue

  uses: imjohnbo/issue-bot@v3

  with:

    assignees: ${{ steps.get-members.outputs.members }}

    title: Hello, world

    body: |-

      :wave: Hi, {{#each assignees}}@{{this}}{{#unless @last}}, {{/unless}}{{/each}}!

```

[token docs]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token