Wiki
Clone wikijtp / Home
Twitter Plugin for JIRA
Welcome to Twitter Plugin for JIRA wiki page!
Twitter Plugin for JIRA is fully open source.
Name | Twitter Plugin for JIRA |
---|---|
Version | 1.3.0 |
JIRA Version | 6.0 - |
Author | Tuncay Senturk |
Issue Tracking | https://bitbucket.org/tuncaysenturk/jtp/issues |
Try and use | https://marketplace.atlassian.com/plugins/plugin.jtp |
Source | https://bitbucket.org/tuncaysenturk/jtp/src |
Description/Features
Socialize your JIRA with Twitter Plugin
This plugin makes you follow JIRA projects via Twitter. You may be notified by all of your workflow steps that you want, and you may create issues or comment on issues by just using your Twitter account.
Just configure the plugin with a Twitter account(application) of your company or JIRA project, then do your basic JIRA works within Twitter, even if you do not have a connection to your company.
Twitter Plugin for JIRA's basic functions :
- Project notifier via Twitter : By defining workflow post function(s), you will be able to see every issue actions as tweets. For instance, you may define a post function as "Notify followers, whenever an issue is created" or "Notify followers, when an "Improvement" issue is resolved", and so on.
You may change tweet content as a simple runtime configuration.
- Creating issue via Twitter : With a single tweet (mentioning to project account), you will be able to create an issue within the project.
- Commenting on an issue : By replying to any tweet, you will be able to comment on the issue.
Installation and Usage
Twitter settings
- Create a twitter account (https://dev.twitter.com/apps/new) (FooProject has been created for demo)
- If you do not want public users, except your internal users, to see your JIRA issues via Twitter, you have to check tweet privacy in your Twitter settings
- Visit https://twitter.com/oauth_clients/new to acquire consumer key, and consumer secret
- Select read/write access
- Click "Create an application" link (https://dev.twitter.com/apps/new)
- Don't forget to set a callback URL. You may set it to any value except blank. For instance, http://anyUrl.com. The right callback URL will be given by the Twitter Plugin in the runtime.}}
- Follow the instruction in the Twitter creating application site
Twitter Plugin for JIRA settings
All documentation is done using JIRA 5.1.4
- You may pick any workflow transition to add Twitter notification. Let's add a Twitter notification to "Create Issue" transition
- Edit your workflow and click "View Post Functions" menu item
- Click "Add" link to create your own Twitter post function
- In the upcoming screen select "Tweet postfunction"
Then click Ok button
- Add your own template. Here you may enter whatever you want (Not only static data but also the dynamic data)
(I'm going to define a template just as below)
"New issue has been created. $newline $issue.key $issue.summary $newline Reporter : $issue.reporter.displayName $newline Assignee : $issue.assignee.displayName"
Do not worry about the $ characters and dynamic velocity parameters. Some important velocity parameters are listed in Velocity Parameter section below.
(Note : if you are creating a post function to "Create Issue", and you want to use issue's key, you have to move down the "twitter post function" after "Creates issue originally" function. JIRA has to create issue in order to get key value :) )
- Publish workflow in the upper right menu button
- Now, it's time to configure Twitter Plugin for JIRA by clicking "Plugins > Twitter Plugin For JIRA" administration menu
Remember not to have any logged in account to www.twitter.com other than Jira account that we will give authorization
In the Main settings page;
- You can see your license status
- If you do not want anyone except your followers to create issues on your JIRA system, you have to check "Only followers may create issues" checkbox.
If this checkbox is checked, plugin will control the Twitter user. If he/she is not in your follower list, he/she can not create issues on your system.
- Select the JIRA project that Twitter listener will create issues within this project whenever tweets arrive
- Pick the JIRA user who will be the reporter of that issue (as long as we do not have any relationship with JIRA user and Twitter account)
- Likely you have to select the issue type
- There is a link to Twitter account configuration page. You have to authorize your Twitter account once.
If you click the link you will see "Authorize your Twitter Account" page as below
In this page, you can see Twitter Plugin's status as Running or Stopped. And there are links to change the status as "Restart" and "Stop". To authorize Twitter account, you have to edit your Consumer key and Consumer secret, andthen click to the "Authorize application" button. This will get you through Twitter site to authorize your Twitter account.
Click Authorize App button and this will get you back to your JIRA admin site.
Twitter Plugin in action
- Create an issue with "New Feature" issue type. (Because we added a post function, to send a tweet, whenever an issue is created with issue types of "New feature" or "Improvement")
- You will see that a tweet has been sent from @FooProject twitter account
- Let's reply to the tweet with a follower of @FooProject
- As expected, reply text will be a comment to the issue (with twitter account name below)
However, only replies to defined Twitter account (here it is @FooProject) will add a comment on issue.
- What if we want to create a new issue via Twitter? That's so simple. Just tweet with annotating twitter account that you configured. (Here it is @FooProject)
- Issue is created
Velocity Parameters
Velocity Parameter | Meaning |
---|---|
$newline | new line (Enter character |
$issue | All issue properties are under this parameter. See link http://docs.atlassian.com/jira/latest/com/atlassian/jira/issue/Issue.html or some important parameters are below |
$issue.created | Issue's created date |
$issue.description | Issue's description |
$issue.dueDate | Issue's due date |
$issue.environment | ıssue's environment |
$issue.estimate | Issue's estimation value |
$issue.key | Issue's key value (e.g FOO-18) |
$issue.affectedVersions | Collection of Version. See link http://docs.atlassian.com/jira/latest/com/atlassian/jira/project/version/Version.html or some important parameters are below |
$issue.affectedVersion.name | Name of the version |
$issue.affectedVersion.description | Description of the version |
$issue.affectedVersion.releaseDate | Release Date of the version |
$issue.fixVersions | Same as $issue.affectedVersions |
$issue.assignee.displayName | Display name of the user that the issue is assigned to |
$issue.assignee.name | Username of the user that the issue is assigned to |
$issue.assignee.emailAddress | Email address of the user that the issue is assigned to |
$issue.reporter.displayName | Display name of the user that the issue is created by |
$issue.reporter.name | Username of the user that the issue is created by |
$issue.reporter.emailAddress | Email address of the user that the issue is created by |
$issue.issueTypeObject | Issue's type object, see details (http://docs.atlassian.com/jira/latest/com/atlassian/jira/issue/issuetype/IssueType.html) |
FAQ
- I get "Twitter stream error, check your internet connection" error message
- Solution : Check your internet connection. If you have firewall do not forget to give access to JIRA instance for below URLs
- I get "You havent logged in with a Twitter account yet" error message
- Solution : Check your internet connection or ensure that your listener is working within Authorizing Twitter Account page.
Updated