Skip to content

Commit ebf6ec8

Browse files
ARC-2784 Update CONTRIBUTING.md and .env.development.local.example to include APP_URL (#2621)
ARC-2784 Update CONTRIBUTING.md and .env.development.local.example to include APP URL
1 parent 223264a commit ebf6ec8

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

Diff for: .env.development.local.example

+3
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ GITHUB_CLIENT_SECRET=
1010
# Path to github private key file (relative to root of this project). If at the root, just specify filename
1111
PRIVATE_KEY_PATH=
1212

13+
# The URL for the local domain obtained after tunneling (ex. `https://__MYDOMAIN__.public.atlastunnel.com` or `https://XXXX-XXX-XXX-XXX-xX.ngrok.io`)
14+
APP_URL=
15+
1316
# The Jira Instance URL you created for this app (ex. https://example.atlassian.net)
1417
ATLASSIAN_URL=
1518

Diff for: CONTRIBUTING.md

+2
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,8 @@ Once you've set up your GitHub app and cloned this repo, copy the file `.env.dev
8181
+ `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).
8282
+ `APP_KEY`: Your Jira app key - need to be unique for your development app
8383
+ `WEBHOOK_SECRETS`: `["development"]` as previously set up in the GitHub app page.
84+
+ `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)
85+
(ex. `https://__MYDOMAIN__.public.atlastunnel.com` or `https://XXXX-XXX-XXX-XXX-xX.ngrok.io`)
8486

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

0 commit comments

Comments
 (0)