Skip to content

Commit 029a9b3

Browse files
authored
Create README.md for delete-repository-event
1 parent 9768782 commit 029a9b3

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# :x: Delete Repository Event
2+
3+
### :dart: Purpose
4+
5+
This Ruby server:
6+
7+
1. Listens for when a [repository is deleted](https://help.github.com/enterprise/user/articles/deleting-a-repository/) using the [`repository`](https://developer.github.com/enterprise/v3/activity/events/types/#repositoryevent) event and `deleted` action.
8+
9+
2. Creates an issue in `GITHUB_NOTIFICATION_REPOSITORY` as a notification and includes:
10+
11+
- a link to restore the repository
12+
- the delete repository payload
13+
14+
### :gear: Configuration
15+
16+
1. See the [webhooks](https://developer.github.com/webhooks/) documentation for information on how to [create webhooks](https://developer.github.com/webhooks/creating/) and [configure your server](https://developer.github.com/webhooks/configuring/).
17+
18+
2. Set the following required environment variables:
19+
20+
- `GITHUB_HOST` - the domain of the GitHub Enterprise instance. e.g. github.example.com
21+
- `GITHUB_API_TOKEN` - a [Personal Access Token](https://help.github.com/enterprise/user/articles/creating-a-personal-access-token-for-the-command-line/) that has the ability to create an issue in the notification repository
22+
- `GITHUB_NOTIFICATION_REPOSITORY` - the repository in which to create the nofication issue. e.g. github.example.com/administrative-notifications

0 commit comments

Comments
 (0)