Skip to content

Commit 5bf1e7c

Browse files
authored
Add audit section to readme file (#660)
Signed-off-by: Sergio Castaño Arteaga <tegioz@icloud.com>
1 parent e90d80c commit 5bf1e7c

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,15 @@ announcements:
104104
> [!NOTE]
105105
> This feature requires some extra permissions to be able to read and write discussions in your repositories. If you installed the GitVote GitHub application before this feature was available (June 2024), you should receive an email from GitHub requesting you to approve these new permissions. Please note that announcements won't be created until those permissions are granted.
106106
107+
### Audit
108+
109+
The audit page publishes the history of votes and some participation stats for a repository. It is disabled by default; to enable it, add the `audit` section with `enabled: true` to your `.gitvote.yml` (see the reference configuration in [`docs/config/.gitvote.yml`](docs/config/.gitvote.yml) for more details).
110+
111+
Once the audit feature is on, GitVote serves the page at `https://gitvote.dev/audit/OWNER/REPO`. The page is public, so anyone can review the voting log.
112+
113+
> [!NOTE]
114+
> It can take up to 15 minutes after enabling the option for the audit page to become available.
115+
107116
## Adopters
108117

109118
Please see [ADOPTERS.md](./ADOPTERS.md) for more details.

0 commit comments

Comments
 (0)