Skip to content

Commit

Permalink
ARC-2784 Update CONTRIBUTING.md and .env.development.local.example to…
Browse files Browse the repository at this point in the history
… include APP_URL (#2621)

ARC-2784 Update CONTRIBUTING.md and .env.development.local.example to include APP URL
  • Loading branch information
yvonnevictoria authored Jan 2, 2024
1 parent 223264a commit ebf6ec8
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .env.development.local.example
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ GITHUB_CLIENT_SECRET=
# Path to github private key file (relative to root of this project). If at the root, just specify filename
PRIVATE_KEY_PATH=

# The URL for the local domain obtained after tunneling (ex. `https://__MYDOMAIN__.public.atlastunnel.com` or `https://XXXX-XXX-XXX-XXX-xX.ngrok.io`)
APP_URL=

# The Jira Instance URL you created for this app (ex. https://example.atlassian.net)
ATLASSIAN_URL=

Expand Down
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,8 @@ Once you've set up your GitHub app and cloned this repo, copy the file `.env.dev
+ `ATLASSIAN_URL`: The URL for the Jira instance you're testing on. If you don't have one now, [please set the value of this variable from the steps mentioned here](#create-your-jira-instance).
+ `APP_KEY`: Your Jira app key - need to be unique for your development app
+ `WEBHOOK_SECRETS`: `["development"]` as previously set up in the GitHub app page.
+ `APP_URL`: The URL for the local domain obtained after tunneling. This should be the same as the `Domain` value set when you [configured your GitHub App](#configuring-a-github-app)
(ex. `https://__MYDOMAIN__.public.atlastunnel.com` or `https://XXXX-XXX-XXX-XXX-xX.ngrok.io`)

Lastly, you need to replace the value of the follow variables in the global `.env` file:

Expand Down

0 comments on commit ebf6ec8

Please sign in to comment.