https://github.com/kevinzunigacuellar/coauthor-action

A GitHub Action that generates a list of coauthors from a pull request and writes them to a comment
https://github.com/kevinzunigacuellar/coauthor-action

Last synced: 22 days ago
JSON representation

A GitHub Action that generates a list of coauthors from a pull request and writes them to a comment

• Host: GitHub
• URL: https://github.com/kevinzunigacuellar/coauthor-action
• Owner: kevinzunigacuellar
• Created: 2024-01-10T02:37:22.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-05-01T18:25:52.000Z (7 months ago)
• Last Synced: 2024-10-04T18:57:50.562Z (about 1 month ago)
• Language: TypeScript
• Homepage:
• Size: 30.3 KB
• Stars: 7
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Generate Co-authors

A GitHub Action that compiles a list of coauthors involved in a pull request and posts the "Coauthor-by" string as a comment.

## Usage

```yaml

name: Write coauthors to a pull request

permissions:

  pull-requests: write

  

on:

  issue_comment:

    types:

      - created

      

jobs:

  generate-coauthors:

    name: Generate Coauthor

    if: ${{ github.event.issue.pull_request }}

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v4

      - uses: kevinzunigacuellar/[email protected]

```

## Inputs

| Name             | Description                                               | Default        |

|------------------|-----------------------------------------------------------|----------------|

| `token`          | GITHUB_TOKEN (pull-requests: write) or a repo scoped PAT. | `GITHUB_TOKEN` |

| `trigger-phrase` | A comment that triggers the action.                       | `!coauthor`    |