generated from myrotvorets/ts-action-template
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ee7499d
commit 3b9efd1
Showing
12 changed files
with
922 additions
and
4,390 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
name: Dispatch Handler | ||
|
||
on: | ||
repository_dispatch: | ||
type: | ||
- ci | ||
|
||
jobs: | ||
dispatcher: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Payload params | ||
run: | | ||
echo "Ref: ${{ github.event.client_payload.ref }}" | ||
echo "Commit: ${{ github.event.client_payload.sha }}" | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,47 @@ | ||
# action_name | ||
# Trigger repository_dispatch Action | ||
|
||
Description. | ||
Triggers a [`repository_dispatch`](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#create-a-repository-dispatch-event) event for the given repository. | ||
|
||
## Inputs | ||
|
||
* … | ||
| Name | Default | Required? | Description | | ||
| --------- | ------------------- | --------- | ----------- | | ||
| `token` | | **YES** | A [Personal Access Token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) with `repo` scope | | ||
| `repo` | `github.repository` | No | The name of the repository to send the event (`owner/repo`) | | ||
| `type` | | **YES** | A custom webhook event name | | ||
| `payload` | | No | JSON payload with extra information about the webhook event that your action or worklow may use. GitHub API allows for a maximum of 10 top-level properties | | ||
|
||
## Outputs | ||
## Example usage | ||
|
||
* … | ||
In the workflow that needs to trigger a `repository_dispatch` action: | ||
|
||
## Example usage | ||
```yaml | ||
- name: Repository Dispatch | ||
uses: myrotvorets/[email protected] | ||
with: | ||
token: ${{ secrets.REPOSITORY_ACCESS_TOKEN }} | ||
repo: username/my-repo | ||
type: my-custom-event | ||
payload: '{ "ref": "${{ github.ref }}", "sha": "${{ github.sha }}" }' | ||
``` | ||
A workflow that handles `repository_dispatch` action: | ||
|
||
```yaml | ||
name: Repository Dispatch | ||
on: | ||
repository_dispatch: | ||
types: | ||
- my-custom-event | ||
jobs: | ||
handle-dispatch: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Print commit hash | ||
run: echo ${{ github.event.client_payload.sha }} | ||
… | ||
- name: Checkout | ||
uses: actions/checkout@v2 | ||
with: | ||
ref: ${{ github.event.client_payload.ref }} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,22 @@ | ||
name: 'action-name' | ||
description: 'Action description' | ||
author: 'Myrotvorets' | ||
#inputs: | ||
|
||
#outputs: | ||
|
||
name: Trigger Repository Dispatch | ||
description: GitHub action to trigger a repository_dispatch event | ||
author: Myrotvorets | ||
inputs: | ||
token: | ||
description: A Personal Access Token with repo scope. Do not use GITHUB_TOKEN. | ||
required: true | ||
repo: | ||
description: A repository (owner/repo) to send the dispatch to | ||
required: false | ||
type: | ||
description: A custom webhook event name | ||
required: true | ||
payload: | ||
description: An optional JSON payload with extra information about the webhook event that your action or worklow may use. Up to 10 top-level properties are allowed | ||
required: false | ||
runs: | ||
using: 'node12' | ||
main: 'dist/index.js' | ||
|
||
#branding: | ||
# color: blue | ||
# icon: info | ||
branding: | ||
color: blue | ||
icon: activity |
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.