Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
myyk committed May 29, 2023
1 parent aed50bc commit a053f4f
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ jobs:
steps:
- uses: actions/checkout@v2
- name: Evaluate vote
uses: myyk/git-democracy@v1
uses: myyk/git-democracy@v2
```

The name of the workflow must be `Voting` to match the badge that will be
Expand Down Expand Up @@ -127,3 +127,13 @@ jienormous: 1
## Sample Project

An example of a fully wired up project: https://github.com/myyk/git-democracy-example

# Migration from v1 to v2 guide

Please do not use `v1` tag as it is not secure since a pull requester could overwrite your `.voters.yml` and `.voting.yml` files.

Easy upgrade steps:

1. Move your `.voters.yml` and `.voting.yml` files into your `.github/workflows/` directory somewhere.
1. Make sure all your voters are also Pull Requesters in your repo/org/account settings.
1. Update `uses: myyk/git-democracy@v1` -> `uses: myyk/git-democracy@v2`

0 comments on commit a053f4f

Please sign in to comment.