-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathplugin-skeleton.html
262 lines (230 loc) · 12.7 KB
/
plugin-skeleton.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<meta name="description" content="Atlassian Jira Plugin Development Tutorials: Plugin Skeleton Tutorial">
<meta name="keywords" content="jiradev, jira, plugins, bhushan154, tutorials, jira, jira training india, jira training">
<meta name="author" content="Bhushan Nagaraj">
<link rel="stylesheet" type="text/css" href="stylesheets/bootstrap.min.css" media="screen" />
<link rel="icon" type="image/x-icon" href="favicon4.ico">
<style type="text/css">
body { padding-bottom: 70px; padding-top: 70px;}
.socials {padding-top: 15px; padding-right: 15px; }
</style>
<title>Jiradev.com: Atlassian Plugin Skeleton</title>
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
<!-- Analytics -->
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-44222850-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<nav class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="navbar-header" style="padding-top: 5px;"><a href="index.html"><img src="images/jiradevlogo.png" alt="Jiradev.com" max-height="40px"/></a></div>
<div class="collapse navbar-collapse navbar-ex1-collapse">
<ul class="nav navbar-nav">
<li class="active"><a href="tutorials.html">Tutorials</a></li>
<li><a href="aboutme.html">About me</a></li>
<li><a href="http://blog.jiradev.com" target="_blank">Blog</a></li>
<li><a href="contact.html">Feedback/Contact</a></li>
</ul>
<ul class="nav navbar-nav pull-right">
<li class="socials">
<a href="https://twitter.com/jiradev" class="twitter-follow-button" data-show-count="false">Follow @jiradev</a>
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
</li>
<li class="socials"><a href="https://twitter.com/share" class="twitter-share-button" data-count="none" data-url="www.jiradev.com" data-text="Check out jiradev.com. It's got simple tutorials for devs new to Jira Development" data-via="jiradev" data-hashtags="JIRA,atlassian">Tweet</a></li>
</ul>
</div>
</nav>
<div class="container">
<div class="row">
<div class="col-md-12">
<div class="page-header"><h1>Plugin skeleton</h1></div>
<p>
In this tutorial, we are going to start using the the Atlassian SDK and run it using the atlas-run command. We will
check if the plugin is installed and look at the demo modules provided by the atlas-create-jira-plugin command.
</p>
<p>Source code available at <a href="https://bitbucket.org/jiradev-tutorials/plugin-skeleton">https://bitbucket.org/jiradev-tutorials/plugin-skeleton</a></p>
<ol>
<li>
Open up a terminal and in a directory of your choice, run the "atlas-create-jira-plugin" command.<br/><br/>
<img class="img-thumbnail" src="images/lesson3/atlas-create-jira-plugin.png"/><br /><br />
</li>
<li>
The SDK now asks you enter the following values.
<div class="alert alert-info">
<p>Define value for groupId: com.jiradev.jira.plugins</p>
<p>Define value for artifactId: skeleton</p>
<p>Define value for version: 1.0</p>
<p>Define value for package: (Just press enter key)</p>
<p>Press [Y] to confirm: Y</p>
</div>
<img class="img-thumbnail" src="images/lesson3/confirm.png"/><br /><br />
</li>
<li>The SDK will have created a new folder named after the artifactId. In our case, the folder will be named skeleton.</li>
<li>Within the folder named skeleton, you will find a file named pom.xml. Open this file and you will find all the information
you entered above.<br /><br />
<img class="img-thumbnail" src="images/lesson3/pom.png"/><br /><br />
Go ahead and update the Organization name and website to your name and your website. You can also update the description
of the plugin.<br /><br />
<img class="img-thumbnail" src="images/lesson3/org-details.png"/><br /><br />
</li>
<li>Pom.xml also contains information related to the Jira version this plugin is intended for. Scroll down to the
end of the file and you will find <jira.version> property. You can update this to any particular JIRA version.<br /><br />
<img class="img-thumbnail" src="images/lesson3/jira-version.png"/><br /><br /></li>
<li>From within the "skeleton" directory, run the command "atlas-run".
<div class="alert alert-danger">
<ul><li>Since you are running the atlas-run command for the first time, all your project's maven
dependencies need to be downloaded. If you are behind a firewall, you may have issues downloading these dependencies.</li>
<li>If you are running an anti-virus software like McAfee, it sometimes causes issues while running the atlas-run command. Disable
your anti-virus.</li>
</ul>
</div>
<img class="img-thumbnail" src="images/lesson3/atlas-run.png"/><br /><br />
</li>
<li>As mentioned in the output, your instance of JIRA will now be accessible at http://localhost:2990/jira. Login using the username
"admin" and password "admin". Go to "Administration" and go to "Manage Add-ons". You should now see the "skeleton" plugin that we just
created.<br /><br />
<img class="img-thumbnail" src="images/lesson3/manage.png"/><br /><br /></li>
<li>Great. You now know how to create a basic plugin skeleton and use the atlas-run command. To terminate the current
execution, press Ctrl+C.</li>
<li>Notice the skeleton directory now contains a new directory called "target". This is generated by atlas-run and contains all the
files required by your local instance of JIRA that you just accessed. From the skeleton directory, run the command "atlas-clean".
This will delete the target folder. A new instance of JIRA will be created the next time you run atlas-run.</li>
</ol>
</div>
</div>
<hr />
<div class="row">
<div class="col-md-4">
<div class="alert alert-info">
<center>
<h4>Share</h4>
<hr />
<p>
Show your support by tweeting about this tutorial. Is Jiradev something you would reommend? <a href="#" id="recommend">Let me know</a>.
</p>
<p>
<div><a class="btn btn-danger btn-sm" href="https://twitter.com/intent/tweet?screen_name=jiradev&text=Woohoo.%20I%20completed%20the%20atlassian-sdk%20installation%20tutorial%20on%20%40jiradev.%20%23atlassian%2C%20%23JIRA" data-related="jiradev">@jiradev</a></div>
</p>
</center>
</div>
</div>
<div class="col-md-4">
<div class="alert alert-info">
<center>
<h4>Contribute</h4>
<hr />
<p>Do you have a Jira plugin tutorial that can be used on this site? Please do share it with me and I can add it along with the ones available.
</p><p><a class="btn btn-danger btn-sm" href="http://jiradev.uservoice.com/knowledgebase/articles/255497">Contribute</a></p>
</center>
</div>
</div>
<div class="col-md-4">
<div class="alert alert-info">
<center>
<h4>Feedback</h4>
<hr />
<p>Your feedback can help improve the content on this site. If you have anything that you would like me to change/implement
on the site.</p><p><div><a href="#" id="feedback" class="btn btn-danger btn-sm">Feedback</a></div></p>
</center>
</div>
</div>
</div>
</div>
<nav class="navbar navbar-default navbar-fixed-bottom">
<div class="row">
<div class="col-md-12">
<p class="text-center">For more information about Jira Plugin Development and Training, contact <a href="mailto:[email protected]">Bhushan Nagaraj</a></p>
</div>
</div>
</nav>
<!-- Satisfaction rating -->
<script>
// Include the UserVoice JavaScript SDK (only needed once on a page)
UserVoice=window.UserVoice||[];(function(){var uv=document.createElement('script');uv.type='text/javascript';uv.async=true;uv.src='//widget.uservoice.com/H4Msyrsib8lTi0nIUcNSPg.js';var s=document.getElementsByTagName('script')[0];s.parentNode.insertBefore(uv,s)})();
//
// UserVoice Javascript SDK developer documentation:
// https://www.uservoice.com/o/javascript-sdk
//
// Set colors
UserVoice.push(['set', {
accent_color: '#e23a39',
trigger_color: 'white',
trigger_background_color: 'rgba(46, 49, 51, 0.6)'
}]);
// Identify the user and pass traits
// To enable, replace sample data with actual user traits and uncomment the line
UserVoice.push(['identify', {
//email: '[email protected]', // User’s email address
//name: 'John Doe', // User’s real name
//created_at: 1364406966, // Unix timestamp for the date the user signed up
//id: 123, // Optional: Unique id of the user (if set, this should not change)
//type: 'Owner', // Optional: segment your users by type
//account: {
// id: 123, // Optional: associate multiple users with a single account
// name: 'Acme, Co.', // Account name
// created_at: 1364406966, // Unix timestamp for the date the account was created
// monthly_rate: 9.99, // Decimal; monthly rate of the account
// ltv: 1495.00, // Decimal; lifetime value of the account
// plan: 'Enhanced' // Plan name for the account
//}
}]);
// Add default trigger to the bottom-right corner of the window:
UserVoice.push(['addTrigger', { mode: 'satisfaction', trigger_position: 'bottom-right' }]);
// Or, use your own custom trigger:
UserVoice.push(['addTrigger', '#recommend', { mode: 'satisfaction' }]);
// Autoprompt for Satisfaction and SmartVote (only displayed under certain conditions)
UserVoice.push(['autoprompt', {}]);
</script>
<!-- Feedback -->
<script>
// Include the UserVoice JavaScript SDK (only needed once on a page)
UserVoice=window.UserVoice||[];(function(){var uv=document.createElement('script');uv.type='text/javascript';uv.async=true;uv.src='//widget.uservoice.com/H4Msyrsib8lTi0nIUcNSPg.js';var s=document.getElementsByTagName('script')[0];s.parentNode.insertBefore(uv,s)})();
//
// UserVoice Javascript SDK developer documentation:
// https://www.uservoice.com/o/javascript-sdk
//
// Set colors
UserVoice.push(['set', {
accent_color: '#e23a39',
trigger_color: 'white',
trigger_background_color: 'rgba(46, 49, 51, 0.6)'
}]);
// Identify the user and pass traits
// To enable, replace sample data with actual user traits and uncomment the line
UserVoice.push(['identify', {
//email: '[email protected]', // User’s email address
//name: 'John Doe', // User’s real name
//created_at: 1364406966, // Unix timestamp for the date the user signed up
//id: 123, // Optional: Unique id of the user (if set, this should not change)
//type: 'Owner', // Optional: segment your users by type
//account: {
// id: 123, // Optional: associate multiple users with a single account
// name: 'Acme, Co.', // Account name
// created_at: 1364406966, // Unix timestamp for the date the account was created
// monthly_rate: 9.99, // Decimal; monthly rate of the account
// ltv: 1495.00, // Decimal; lifetime value of the account
// plan: 'Enhanced' // Plan name for the account
//}
}]);
// Add default trigger to the bottom-right corner of the window:
//UserVoice.push(['addTrigger', { mode: 'smartvote', trigger_position: 'bottom-right' }]);
// Or, use your own custom trigger:
UserVoice.push(['addTrigger', '#feedback', { mode: 'smartvote' }]);
// Autoprompt for Satisfaction and SmartVote (only displayed under certain conditions)
UserVoice.push(['autoprompt', {}]);
</script>
</body>
</html>