Setup
- Create a new JIRA Project
- Create a Custom Field in Jira that is a text input, and available on all Screens for your Jira Project Issues.
- Get the SMTP credentials for your email service provider, you’ll need to build a
MAILER_URL
(see below) for any operations to send email. - Create a Github Oauth Token
- Create a Jira Oauth Token
Configuration
To get started simply copy .env.dist
to .env
and customize with your options.
cp app/.env.dist app/.env
Config Name | Description | Value | |
---|---|---|---|
APP_USER_EMAIL |
Who should receive emails from the processors? | jake.litwicki@example.com | |
PAGE_SIZE |
100 | ||
JIRA_HOST |
“https://example.atlassian.net” | ||
JIRA_USER |
“jirabot@example.com” | ||
JIRA_PASS |
“p4ssw0rd!” | ||
JIRA_CUSTOM_FIELD_GITHUB_ISSUE |
customfield_##### | Get the field id from the field you create | |
JIRA_CUSTOM_FIELD_EPIC_LINK |
customfield_10013 | This is the default | |
JIRA_CUSTOM_FIELD_EPIC_NAME |
customfield_10010 | This is the default | |
JIRA_CLOSED_TRANSITION |
Closed | Default is Closed but should map to your final workflow status |
|
GITHUB_ORGANIZATION |
Acme Corp | ||
GITHUB_AUTH_METHOD |
see client docs | http_token | |
GITHUB_USERNAME |
see client docs | Oauth Token Value | |
GITHUB_SECRET |
see client docs | Oauth Token Value | |
MAILER_URL |
Build your URL with the parameters from your service provider. | ||
MAILER_FROM_ADDRESS |
noreply@example.com | ||
MAILER_DEFAULT_SUBJECT |
“Github2Jira” | ||
EMAIL_SIGNATURE_TXT |
‘text formatted string with no line breaks; can include \n for line breaks’ |
||
EMAIL_SIGNATURE_HTML |
“html formatted string with no line breaks” |