Skip to content

Update README.md #4

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
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update README.md #4

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
783a7a4
Update README.md
ctcampbell Dec 12, 2023
e7801ac
Add description
ctcampbell Dec 13, 2023
a4b0528
Update README.md
ctcampbell Dec 13, 2023
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
51 changes: 30 additions & 21 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,30 @@
# azure-probot-template

Edit `src/functions/app.ts` as required:

```ts
export = (app: Probot) => {
app.on("issues.opened", async (context) => {
const issueComment = context.issue({
body: "Thanks for opening this issue!",
});
await context.octokit.issues.createComment(issueComment);
});
```

Create a GitHub app and install it on a repo, then deploy this repo to an Azure Function with the following application settings:

```
APP_ID=.....
PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\n.....
WEBHOOK_SECRET=.....
```
# github-webhook-mirror

Sends a `repository_dispatch` event back to a GitHub repo when a webhook event is sent. This allows Actions to run on events that are not yet supported as direct triggers such as `code_scanning_alert`.

## Usage

### Create a GitHub app on your organisation

1. Set an appropriate name and Homepage URL

<img width="500" alt="Screenshot 2023-12-13 at 15 02 32" src="https://github.com/ctcampbell/github-webhook-mirror/assets/808531/05269b8f-a689-419f-bf8e-38cb73196411">

2. Uncheck the Webhook active checkbox, we will come back to this later

<img width="500" alt="Screenshot 2023-12-13 at 15 02 39" src="https://github.com/ctcampbell/github-webhook-mirror/assets/808531/b591d53b-f7ee-464d-a320-6195ee541b53">

3. Set the app permissions to allow `Read and write` for repository contents. This allows the Probot app to send `repository_dispatch` events to the source repository.

<img width="500" alt="Screenshot 2023-12-13 at 15 03 19" src="https://github.com/ctcampbell/github-webhook-mirror/assets/808531/42a5e5d7-025d-4650-ac10-40d2743457f0">

4. Generate a private key for the app.

<img width="500" alt="Screenshot 2023-12-13 at 15 03 51" src="https://github.com/ctcampbell/github-webhook-mirror/assets/808531/d77e3694-63b9-4814-bb77-9acb90683713">

5. Don't forget to install the app on an organisation.

<img width="500" alt="Screenshot 2023-12-13 at 16 15 01" src="https://github.com/ctcampbell/github-webhook-mirror/assets/808531/aa9984fc-7ffa-4602-8ebf-f2f516af1af1">


### Create an Azure Function App