Skip to content

Commit

Permalink
Add installation information in README.md (#70)
Browse files Browse the repository at this point in the history
  • Loading branch information
beliaev-maksim authored Dec 20, 2024
1 parent 63bddd2 commit e3dc532
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,21 @@ The following environment variables are required:
`APP_ID` - GitHub App ID
`PRIVATE_KEY` - GitHub App private key
`WEBHOOK_SECRET` - GitHub App webhook secret
`GITHUB_CLIENT_ID` - GitHub OAuth App client ID
`GITHUB_CLIENT_SECRET` - GitHub OAuth App client secret
`JIRA_INSTANCE` - Jira instance URL
`JIRA_USERNAME` - Jira username
`JIRA_TOKEN` - Jira API token

## GitHub App installation
This app is meant to be installed as a GitHub application.

1. [Register a new GitHub app](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app).
2. Make sure to:
- Generate a private key for the app.
- Set up a webhook secret.
- Add these repository permissions:
- Issues: read and write
- Metadata: read-only
- Single file: read-only (Path: `.github/.jira_sync_config.yaml`)
- Subscribe to these events:
- Issues
- Issue comments

0 comments on commit e3dc532

Please sign in to comment.