https://github.com/twonds/github-repository-dispatch-buildkite-plugin
A Buildkite plugin for triggering a Github workflow
https://github.com/twonds/github-repository-dispatch-buildkite-plugin
buildkite-plugin github-actions github-repository-dispatch
Last synced: 6 months ago
JSON representation
A Buildkite plugin for triggering a Github workflow
- Host: GitHub
- URL: https://github.com/twonds/github-repository-dispatch-buildkite-plugin
- Owner: twonds
- License: mit
- Created: 2022-06-03T21:55:31.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-23T16:34:31.000Z (about 3 years ago)
- Last Synced: 2025-04-03T05:03:49.443Z (6 months ago)
- Topics: buildkite-plugin, github-actions, github-repository-dispatch
- Language: Shell
- Homepage:
- Size: 20.5 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# github-repository-dispatch-buildkite-plugin
A [Buildkite plugin](https://buildkite.com/docs/agent/v3/plugins) that lets you trigger a Github workflow via a repository dispatch.
## Example
Add the following to your `pipeline.yml`:
```yml
steps:
- command: ls
env:
BUILDKITE_PLUGINS_ALWAYS_CLONE_FRESH: "true"
label: ":github: Trigger github workflow"
plugins:
- twonds/github-repository-dispatch#v0.7.1:
repository: ''
event_type: ''
```
## Configuration
### `repository` (Required, string)
The repository path to use
### `event_type` (Required, string)
The event type of the workflow to indicate what workflow event to trigger.
## Developing
To run the tests:
```shell
docker-compose run --rm tests
```
## Contributing
1. Fork the repo
2. Make the changes
3. Run the tests
4. Commit and push your changes
5. Send a pull request
## TODO
- [x] Trigger Github workflow
- [x] Wait for workflow to complete
- [x] Report on Github workflow URL and status
- [ ] Wait on certain workflow status
- [ ] Complete test coverage
- [ ] Complete documentation