/example

example repo

MIT LicenseMIT

Example

This is an example repository that demonstrates how Vaunt can be applied to projects.

Top Contributors

Achievements

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

Refer to the Vaunt docs for more details on how to leverage Vaunt's achievement configurations.

version: 0.0.1
achievements:
  - achievement:
      name: Shooting Star
      icon: https://raw.githubusercontent.com/vauntdev/example/main/.vaunt/shooting_star.png
      description: Awarded for starring our repository, make a wish!
      triggers:
        - trigger:
            actor: author
            action: star
            condition: starred = true
  - achievement:
      name: Every Bit Counts
      icon: https://raw.githubusercontent.com/vauntdev/example/main/.vaunt/every_bit_counts.png
      description: No commit is too small!
      triggers:
        - trigger:
            actor: author
            action: commit
            condition: count() >= 1
  - achievement:
      name: Pull Request Hero
      icon: https://raw.githubusercontent.com/vauntdev/example/main/.vaunt/pull_request_hero.png
      description: You're a PR hero, rock on!
      triggers:
        - trigger:
            actor: author
            action: pull_request
            condition: merged = true
  - achievement:
      name: Closer
      icon: https://raw.githubusercontent.com/vauntdev/example/main/.vaunt/closer.png
      description: Only closers get coffee!
      triggers:
        - trigger:
            actor: author
            action: issue
            condition: closed = true

Available Awards

Name Icon Description
Shooting Star Awarded for starring our repository, make a wish!
Every Bit Counts No commit is too small!
Pull Request Hero You're a PR hero, rock on!
Closer Only closers get coffee!