Skip to content
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

ARC-2784 Update CONTRIBUTING.md and .env.development.local.example to include APP_URL #2621

Merged
merged 1 commit into from
Jan 2, 2024
+5 −0
Merged

ARC-2784 Update CONTRIBUTING.md and .env.development.local.example to include APP_URL #2621

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions .env.development.local.example
View file
Open in desktop
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
View file
Open in desktop
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
Loading