https://github.com/dkershner6/githubactions-result-reporter

Report Results for actions started using GitHubActions.com
https://github.com/dkershner6/githubactions-result-reporter

github-actions nodejs

Last synced: 29 days ago
JSON representation

Report Results for actions started using GitHubActions.com

• Host: GitHub
• URL: https://github.com/dkershner6/githubactions-result-reporter
• Owner: dkershner6
• License: mit
• Created: 2020-06-19T19:32:26.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-08-03T13:58:02.000Z (over 3 years ago)
• Last Synced: 2024-09-25T16:33:24.775Z (about 2 months ago)
• Topics: github-actions, nodejs
• Language: TypeScript
• Homepage: https://githubactions.com
• Size: 805 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHubActions.com Result Reporter

Report Results for actions started using GitHubActions.com. This action will never fail your workflow, so use freely without risk, but do check for error logs if you don't see results in the GitHubActions.com portal.

## Usage

### Inputs

| key | default | required | description |

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

| trigger_result_id | n/a | true | The ID for the trigger result being reported. This typically is at `github.event.client_payload.triggerResult.triggerResultId` |

| event_result_id | n/a | true | The ID for the individual event being reported. This typically is at `github.event.client_payload.triggerResult.eventResultId` |

| status_code | `success` | false | A status to update to. Valid values: `success`, `processing`, `failure` |

| status_text | `Success!` | false | A string to describe the status code. This is optional, but should be short (max 25 chars). |

### Outputs

None

### Example Workflow

```yaml

on:

  repository_dispatch:

    types: [package-update]

jobs:

  test-coverage:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout code

        uses: actions/checkout@v2

      - name: Report In Process

        uses: dkershner6/githubactions-result-reporter@v1

          with:

            trigger_result_id: '${{ github.event.client_payload.triggerResult.triggerResultId }}'

            event_result_id: '${{ github.event.client_payload.triggerResult.eventResultId }}'

            status_code: 'processing'

            status_text: 'Installing npm...'

      - run: npm i

      - name: Report Success

        uses: dkershner6/githubactions-result-reporter@v1

          with:

            trigger_result_id: '${{ github.event.client_payload.triggerResult.triggerResultId }}'

            event_result_id: '${{ github.event.client_payload.triggerResult.eventResultId }}'

            status_code: 'success'

            status_text: 'NPM was installed.'

```