https://github.com/razonyang/github-org-contributors-action

GitHub Action for listing contributors of specified organization.
https://github.com/razonyang/github-org-contributors-action

Last synced: about 1 month ago
JSON representation

GitHub Action for listing contributors of specified organization.

• Host: GitHub
• URL: https://github.com/razonyang/github-org-contributors-action
• Owner: razonyang
• License: mit
• Created: 2023-04-25T01:38:53.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-05-08T06:53:02.000Z (over 1 year ago)
• Last Synced: 2024-04-13T22:26:23.350Z (7 months ago)
• Language: Go
• Homepage:
• Size: 5.86 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHub Organization Contributors Action

This action fetch contributors of a specified GitHub organization, and output to a file in `YAML`, `TOML` or `JSON` format.

## Inputs

| Parameter |  Type  | Default | Required | Description                                                                              |

| --------- | :----: | :-----: | :------: | ---------------------------------------------------------------------------------------- |

| `org`     | string |    -    |    Y     | The organization name.                                                                   |

| `output`  | string |    -    |    Y     | The output filename, i.e. `contributors.toml`, `contributors.yaml`, `contributors.json`. |

## Example

```yaml

on:

  workflow_dispatch:

  schedule:

    - cron: '0 */6 * * *'

jobs:

  contributors:

    permissions:

      contents: write

    runs-on: ubuntu-latest

    name: List contributors

    steps:

      - name: Checkout

        uses: actions/checkout@v3

      - name: Get contributors

        uses: razonyang/github-org-contributors-action@main

        id: contributors

        env:

          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

        with:

          org: 'hugomods'

          output: 'data/contributors.toml'

      - run: cat data/contributors.toml

      - uses: stefanzweifel/git-auto-commit-action@v4

        with:

          commit_message: "chore: update data/contributors.toml"

          file_pattern: 'data/contributors.toml'

```