Skip to content

Update README.md to include webhook #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
simonmazzaroth wants to merge 1 commit into
base: simonmazzaroth-readme-fix
Choose a base branch
from
Open

Update README.md to include webhook #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This is an example repository that demonstrates how Vaunt can be applied to proj

This repository leverages Vaunt's standard achievements defined in `./vaunt/config.yaml`.

Refer to the Vaunt [docs](https://docs.vaunt.dev) for more details on how to leverage Vaunt's achievement configurations.
Refer to the Vaunt [docs](https://docs.vaunt.dev) for more details on how to leverage Vaunt's achievement and notifications configurations.

```yaml
version: 0.0.1
Expand Down Expand Up @@ -51,6 +51,27 @@ achievements:
actor: author
action: issue
condition: closed = true
webhooks:
- webhook:
name: achievements
type: github
metadata:
discussion:
repository: VauntDev/example
title: Vaunt Achievements
events:
- event:
type: achievement
value: Shooting Star
- event:
type: achievement
value: Every Bit Counts
- event:
type: achievement
value: Pull Request Hero
- event:
type: achievement
value: Closer
```

### Available Awards
Expand Down