https://github.com/quipper/comment-failure-action

Add comments for what workflows and jobs failed in pull request.
https://github.com/quipper/comment-failure-action

Last synced: about 1 year ago
JSON representation

Add comments for what workflows and jobs failed in pull request.

• Host: GitHub
• URL: https://github.com/quipper/comment-failure-action
• Owner: quipper
• License: mit
• Created: 2021-02-17T11:53:53.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-03-06T23:00:35.000Z (about 3 years ago)
• Last Synced: 2025-04-21T02:55:07.430Z (about 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 982 KB
• Stars: 11
• Watchers: 115
• Forks: 2
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![build-test](https://github.com/quipper/comment-failure-action/workflows/build-test/badge.svg)

# Comment Failure Action

Add comments for what workflows and jobs failed in pull request.

## Demo

Please see https://github.com/quipper/comment-failure-action/pull/6.

## Usage

```yaml

on:

  workflow_run:

    workflows:

      - your-workflow  # Replace with your test workflow's name

    types: [ completed ]

jobs:

  comment-failure:

    runs-on: ubuntu-latest

    steps:

      - uses: quipper/comment-failure-action@v0.1.1

```

If you want to use your own personal access token, specify it with `api-token`:

```yaml

on:

  workflow_run:

    workflows:

      - your-workflow  # Replace with your test workflow's name

    types: [ completed ]

jobs:

  comment-failure:

    runs-on: ubuntu-latest

    steps:

      - uses: quipper/comment-failure-action@v0.1.1

        with:

          api-token: ${{ secrets.YOUR_GITHUB_TOKEN }} # Replace with your secret's name

```

### Inputs

| Name      | Required | Default               | Description                                      |

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

| api-token | `true`   | `${{ github.token }}` | GitHub API token granted `repo` or `public_repo` |

Regarding `api-token`, we recommend you to use the default value because `github.token` is regenerated for each run, and its permission is limited to the repository that contains the workflow.

For more information, please see https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#github-context and https://docs.github.com/en/actions/reference/authentication-in-a-workflow.

## Notice

This repository was initially cloned from https://github.com/actions/typescript-action.