forked from NASA-PDS/nasa-pds.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpds_ci_cd.html
367 lines (247 loc) · 11.9 KB
/
pds_ci_cd.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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>PDS Continuous Integration / Continuous Deployment — NASA PDS Software documentation</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="PDS Software Documentation Best Practices" href="pds_sw_docs.html" />
<link rel="prev" title="PDS Issue Tracking" href="pds_issue_tracking_guide.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home" alt="Documentation Home"> NASA PDS Software
<img src="../_static/PDS_Planets.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">System Releases</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../releases_bkp/release.html">Releases</a></li>
<li class="toctree-l1"><a class="reference internal" href="../releases_bkp/plan.html">Releases</a></li>
</ul>
<p class="caption"><span class="caption-text">Developer Guides`</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="pds_git_and_github_guide.html">PDS Git and Github Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="pds_issue_tracking_guide.html">PDS Issue Tracking</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">PDS Continuous Integration / Continuous Deployment</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#purpose">Purpose</a></li>
<li class="toctree-l2"><a class="reference internal" href="#stable-releases">Stable Releases</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#github-actions-example">Github Actions Example</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#unstable-releases">Unstable Releases</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pds_sw_docs.html">PDS Software Documentation Best Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="seo.html">Search Engine Optimization</a></li>
</ul>
<p class="caption"><span class="caption-text">Teams</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../teams/teams.html">Teams</a></li>
</ul>
<p class="caption"><span class="caption-text">Support</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../support/help.html">Help</a></li>
<li class="toctree-l1"><a class="reference internal" href="../support/forum.html">OpenPlanetary Forum</a></li>
<li class="toctree-l1"><a class="reference internal" href="../support/contribute.html">Contribute</a></li>
<li class="toctree-l1"><a class="reference internal" href="../support/contribute.html#request-a-new-tool-service">Request a New Tool / Service</a></li>
<li class="toctree-l1"><a class="reference internal" href="../support/contribute.html#report-a-bug">Report a Bug</a></li>
<li class="toctree-l1"><a class="reference internal" href="../support/contact.html">Contact Us</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">NASA PDS Software</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> »</li>
<li>PDS Continuous Integration / Continuous Deployment</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/developer/pds_ci_cd.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="pds-continuous-integration-continuous-deployment">
<h1>PDS Continuous Integration / Continuous Deployment<a class="headerlink" href="#pds-continuous-integration-continuous-deployment" title="Permalink to this headline">¶</a></h1>
<hr class="docutils" />
<div class="section" id="purpose">
<h2>Purpose<a class="headerlink" href="#purpose" title="Permalink to this headline">¶</a></h2>
<p>To describe a consistent approach to developing CI/CD processes for PDS
software products.</p>
</div>
<hr class="docutils" />
<div class="section" id="stable-releases">
<h2>Stable Releases<a class="headerlink" href="#stable-releases" title="Permalink to this headline">¶</a></h2>
<p>CI/CD for will differ between stable releases versus unstable releases
(e.g. SNAPSHOT, -dev releases).</p>
<p>Here are the steps we want to accomplish during our stable release CI/CD
process:</p>
<ul class="simple">
<li><p>Identify repo (Java or Python)</p>
<ul>
<li><p>If <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> == Python, <code class="docutils literal notranslate"><span class="pre">pom.xml</span></code> == Java</p></li>
</ul>
</li>
<li><p>Unit Test</p>
<ul>
<li><p>Python - <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">setup.py</span> <span class="pre">test</span></code> (unittest)</p></li>
<li><p>Java - <code class="docutils literal notranslate"><span class="pre">mvn</span> <span class="pre">test</span></code></p></li>
</ul>
</li>
<li><p>Integration Test (TBD technology / best practices)</p></li>
<li><p>Generate Configuration Control Artifacts</p>
<ul>
<li><p>Generate CHANGELOG</p></li>
<li><p>Generate REQUIREMENTS</p></li>
<li><p>Push updates to repo</p></li>
</ul>
</li>
<li><p>Build and deploy software - RELEASE</p>
<ul>
<li><p>Generate and package Documentation</p>
<ul>
<li><p>Python - Sphinx</p></li>
<li><p>Java - <code class="docutils literal notranslate"><span class="pre">mvn</span> <span class="pre">site</span></code></p></li>
</ul>
</li>
<li><p>Build software</p>
<ul>
<li><p>Python - <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">setup.py</span> <span class="pre">wheel</span></code></p></li>
<li><p>Java - <code class="docutils literal notranslate"><span class="pre">mvn</span> <span class="pre">package</span></code></p></li>
</ul>
</li>
<li><p>Publish unstable release to Github Releases</p></li>
<li><p>Publish to public artifact repos</p>
<ul>
<li><p>Python - Test pypi</p></li>
<li><p>Java - Maven central snapshots, upload package to Github assets</p></li>
</ul>
</li>
<li><p>Push Documentation</p>
<ul>
<li><p>To Github Pages</p></li>
<li><p>To Github Release Assets</p></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="section" id="github-actions-example">
<h3>Github Actions Example<a class="headerlink" href="#github-actions-example" title="Permalink to this headline">¶</a></h3>
<p>TBD link to template action or repo for this</p>
</div>
</div>
<hr class="docutils" />
<div class="section" id="unstable-releases">
<h2>Unstable Releases<a class="headerlink" href="#unstable-releases" title="Permalink to this headline">¶</a></h2>
<p>CI/CD for in-development software updates (e.g. Java SNAPSHOTS, Python
-dev)</p>
<ul class="simple">
<li><p>Identify repo (Java or Python)</p></li>
<li><p>Unit Test</p>
<ul>
<li><p>Python - <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">setup.py</span> <span class="pre">test</span></code> (unittest)</p></li>
<li><p>Java - <code class="docutils literal notranslate"><span class="pre">mvn</span> <span class="pre">test</span></code></p></li>
</ul>
</li>
<li><p>Integration Test (TBD technology / best practices)</p></li>
<li><p>Generate Configuration Control Artifacts</p>
<ul>
<li><p>Generate CHANGELOG</p></li>
<li><p>Generate REQUIREMENTS</p></li>
<li><p>Push updates to repo</p></li>
</ul>
</li>
<li><p>Build and deploy software - UNSTABLE</p>
<ul>
<li><p>Generate and package Documentation</p>
<ul>
<li><p>Python - Sphinx</p></li>
<li><p>Java - <code class="docutils literal notranslate"><span class="pre">mvn</span> <span class="pre">site</span></code></p></li>
</ul>
</li>
<li><p>Build software</p>
<ul>
<li><p>Python - <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">setup.py</span> <span class="pre">wheel</span></code></p></li>
<li><p>Java - <code class="docutils literal notranslate"><span class="pre">mvn</span> <span class="pre">package</span></code></p></li>
</ul>
</li>
<li><p>Publish unstable release to Github Releases</p></li>
<li><p>Publish to public artifact repos</p>
<ul>
<li><p>Python - Test pypi</p></li>
<li><p>Java - Maven central snapshots, upload package to Github assets</p></li>
</ul>
</li>
<li><p>Push Documentation</p>
<ul>
<li><p>Push generated docs to Github Release Assets ONLY</p></li>
</ul>
</li>
</ul>
</li>
</ul>
<p>Copyright 2020, California Institute of Technology (“Caltech”). U.S.
Government sponsorship acknowledged.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="pds_sw_docs.html" class="btn btn-neutral float-right" title="PDS Software Documentation Best Practices" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="pds_issue_tracking_guide.html" class="btn btn-neutral float-left" title="PDS Issue Tracking" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2020 California Institute of Technology
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>