-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathindex.html
359 lines (314 loc) · 16.9 KB
/
index.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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Rever: Releaser of Versions! — rever 0.5.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/numpy_friendly.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Noticia+Text|Open+Sans|Droid+Sans+Mono" type="text/css" />
<script 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/jquery.cookie.js"></script>
<script src="_static/cloud.base.js"></script>
<script src="_static/cloud.js"></script>
<link rel="shortcut icon" href="_static/longship.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Dependencies" href="dependencies.html" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="canonical" href="http://xon.sh/index.html"/>
</head><body>
<div class="relbar-top">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> </li>
<li class="right" >
<a href="dependencies.html" title="Dependencies"
accesskey="N">next</a> </li>
<li><a href="#">rever 0.5.0 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Rever: Releaser of Versions!</a></li>
</ul>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="rever-releaser-of-versions">
<h1>Rever: Releaser of Versions!<a class="headerlink" href="#rever-releaser-of-versions" title="Permalink to this headline">¶</a></h1>
<p>Rever is a xonsh-powered, cross-platform software release tool. The
goal of rever is to provide sofware projects a standard mechanism for dealing with
code releases. Rever aims to make the process of releasing a new version of a code base
as easy as running a single command. Rever…</p>
<ul class="simple">
<li><p>has a number of stock tools and utilities that you can mix and match to meet your projects needs,</p></li>
<li><p>is easily extensible, allowing your project to execute custom release activities, and</p></li>
<li><p>allows you to undo release activities, in the event of a mistake!</p></li>
</ul>
<div class="section" id="initializing-rever">
<h2>Initializing Rever<a class="headerlink" href="#initializing-rever" title="Permalink to this headline">¶</a></h2>
<p>There are a couple steps you should take to get the most out of rever.</p>
<ol class="arabic">
<li><p>Install rever. Rever is on conda-forge so install via
<code class="docutils literal notranslate"><span class="pre">conda</span> <span class="pre">install</span> <span class="pre">rever</span> <span class="pre">-c</span> <span class="pre">conda-forge</span></code>, via pypi with <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">re-ver</span></code>,
or from source.</p></li>
<li><p>Setup a <code class="docutils literal notranslate"><span class="pre">rever.xsh</span></code> file in the root directory of your source repository.
Here is a simplified example from <code class="docutils literal notranslate"><span class="pre">rever</span></code> itself,</p>
<blockquote>
<div><div class="highlight-xonsh notranslate"><div class="highlight"><pre><span></span><span class="nv">$PROJECT</span> <span class="o">=</span> <span class="s1">'rever'</span>
<span class="nv">$ACTIVITIES</span> <span class="o">=</span> <span class="p">[</span>
<span class="s1">'version_bump'</span><span class="p">,</span> <span class="c1"># Changes the version number in various source files (setup.py, __init__.py, etc)</span>
<span class="s1">'changelog'</span><span class="p">,</span> <span class="c1"># Uses files in the news folder to create a changelog for release</span>
<span class="s1">'tag'</span><span class="p">,</span> <span class="c1"># Creates a tag for the new version number</span>
<span class="s1">'push_tag'</span><span class="p">,</span> <span class="c1"># Pushes the tag up to the $TAG_REMOTE</span>
<span class="s1">'pypi'</span><span class="p">,</span> <span class="c1"># Sends the package to pypi</span>
<span class="s1">'conda_forge'</span><span class="p">,</span> <span class="c1"># Creates a PR into your package's feedstock</span>
<span class="s1">'ghrelease'</span> <span class="c1"># Creates a Github release entry for the new tag</span>
<span class="p">]</span>
<span class="nv">$VERSION_BUMP_PATTERNS</span> <span class="o">=</span> <span class="p">[</span> <span class="c1"># These note where/how to find the version numbers</span>
<span class="p">(</span><span class="s1">'rever/__init__.py'</span><span class="p">,</span> <span class="sa">r</span><span class="s1">'__version__\s*=.*'</span><span class="p">,</span> <span class="s2">"__version__ = '$VERSION'"</span><span class="p">),</span>
<span class="p">(</span><span class="s1">'setup.py'</span><span class="p">,</span> <span class="sa">r</span><span class="s1">'version\s*=.*,'</span><span class="p">,</span> <span class="s2">"version='$VERSION',"</span><span class="p">)</span>
<span class="p">]</span>
<span class="nv">$CHANGELOG_FILENAME</span> <span class="o">=</span> <span class="s1">'CHANGELOG.rst'</span> <span class="c1"># Filename for the changelog</span>
<span class="nv">$CHANGELOG_TEMPLATE</span> <span class="o">=</span> <span class="s1">'TEMPLATE.rst'</span> <span class="c1"># Filename for the news template</span>
<span class="nv">$PUSH_TAG_REMOTE</span> <span class="o">=</span> <span class="s1">'[email protected]:regro/rever.git'</span> <span class="c1"># Repo to push tags to</span>
<span class="nv">$GITHUB_ORG</span> <span class="o">=</span> <span class="s1">'regro'</span> <span class="c1"># Github org for Github releases and conda-forge</span>
<span class="nv">$GITHUB_REPO</span> <span class="o">=</span> <span class="s1">'rever'</span> <span class="c1"># Github repo for Github releases and conda-forge</span>
</pre></div>
</div>
</div></blockquote>
</li>
<li><p>After setting up the <code class="docutils literal notranslate"><span class="pre">rever.xsh</span></code> file run <code class="docutils literal notranslate"><span class="pre">rever</span> <span class="pre">setup</span></code> in the root
directory of your source repository. This will setup files and other things
needed for rever to operate.</p></li>
<li><p>It is always a good idea to check that you have permissions and the proper
libraries installed, so it is best to run <code class="docutils literal notranslate"><span class="pre">rever</span> <span class="pre">check</span></code> before every release.</p></li>
<li><p>When you are ready to release run <code class="docutils literal notranslate"><span class="pre">rever</span> <span class="pre"><new_version_number></span></code> and rever
will take care of the rest.</p></li>
</ol>
</div>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
<p><strong>Installation:</strong></p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="dependencies.html">Dependencies</a></li>
<li class="toctree-l1"><a class="reference internal" href="dependencies.html#development-dependencies">Development Dependencies</a></li>
</ul>
</div>
<p><strong>Guides:</strong></p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="usepatterns.html">Notes for using rever</a></li>
<li class="toctree-l1"><a class="reference internal" href="news.html">News Workflow</a></li>
<li class="toctree-l1"><a class="reference internal" href="authorship.html">Contributor & Authorship Tracking</a></li>
</ul>
</div>
<p><strong>Configuration & Setup:</strong></p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="activities.html">Activities</a></li>
<li class="toctree-l1"><a class="reference internal" href="envvars.html">Environment Variables</a></li>
</ul>
</div>
<p><strong>Development Spiral:</strong></p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="api/index.html">Rever API</a></li>
<li class="toctree-l1"><a class="reference internal" href="devguide.html">Developer’s Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Rever Change Log</a></li>
</ul>
</div>
</div>
</div>
<div class="section" id="dependencies">
<h1>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h1>
<p>Rever currently has the following external dependencies,</p>
<p><em>Run Time:</em></p>
<blockquote>
<div><ol class="arabic simple">
<li><p>xonsh</p></li>
<li><p>lazyasd</p></li>
<li><p>ruamel.yaml</p></li>
</ol>
</div></blockquote>
</div>
<div class="section" id="development-dependencies">
<h1>Development Dependencies<a class="headerlink" href="#development-dependencies" title="Permalink to this headline">¶</a></h1>
<p>If you want to develop rever, it is extremely recommended to install the dependencies
listed in <a class="reference external" href="https://github.com/regro/rever/blob/master/requirements/docs.txt">requirements/docs.txt</a>
(to generate documentation) and
<a class="reference external" href="https://github.com/regro/rever/blob/master/requirements/tests.txt">requirements/tests.txt</a>
(to run the test suite).</p>
<div class="section" id="contributing">
<h2>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h2>
<p>We highly encourage contributions to rever! If you would like to contribute,
it is as easy as forking the repository on GitHub, making your changes, and
issuing a pull request. If you have any questions about this process don’t
hesitate to ask on the <a class="reference external" href="https://gitter.im/regro/rever">Gitter</a> channel.</p>
<p>See the <a class="reference external" href="devguide.html">Developer’s Guide</a> for more information about contributing.</p>
</div>
<div class="section" id="helpful-links">
<h2>Helpful Links<a class="headerlink" href="#helpful-links" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="http://regro.github.io/rever-docs">Documentation</a></p></li>
<li><p><a class="reference external" href="https://gitter.im/regro/rever">Gitter</a></p></li>
<li><p><a class="reference external" href="https://github.com/regro/rever">GitHub Repository</a></p></li>
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
<a href="https://github.com/regro/rever" class='github-fork-ribbon' title='Fork me on GitHub'>Fork me on GitHub</a>
<style>
/*!
* Adapted from
* "Fork me on GitHub" CSS ribbon v0.2.0 | MIT License
* https://github.com/simonwhitaker/github-fork-ribbon-css
*/
.github-fork-ribbon, .github-fork-ribbon:hover, .github-fork-ribbon:hover:active {
background:none;
left: inherit;
width: 12.1em;
height: 12.1em;
position: absolute;
overflow: hidden;
top: 0;
right: 0;
z-index: 9999;
pointer-events: none;
text-decoration: none;
text-indent: -999999px;
}
.github-fork-ribbon:before, .github-fork-ribbon:after {
/* The right and left classes determine the side we attach our banner to */
position: absolute;
display: block;
width: 15.38em;
height: 1.54em;
top: 3.23em;
right: -3.23em;
box-sizing: content-box;
transform: rotate(45deg);
}
.github-fork-ribbon:before {
content: "";
padding: .38em 0;
background-image: linear-gradient(to bottom, rgba(0, 0, 0, 0), rgba(0, 0, 0, 0.1));
box-shadow: 0 0.07em 0.4em 0 rgba(0, 0, 0, 0.3);'
pointer-events: auto;
}
.github-fork-ribbon:after {
content: attr(title);
color: #000;
font: 700 1em "Helvetica Neue", Helvetica, Arial, sans-serif;
line-height: 1.54em;
text-decoration: none;
text-align: center;
text-indent: 0;
padding: .15em 0;
margin: .15em 0;
border-width: .08em 0;
border-style: dotted;
border-color: #777;
}
</style></div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="#" title="index">
<img class="logo" src="_static/longship-256.png" alt="Logo"/>
</a></p><div class="sphinx-toc sphinxlocaltoc">
<h3><a href="#">Page contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Rever: Releaser of Versions!</a><ul>
<li><a class="reference internal" href="#initializing-rever">Initializing Rever</a></li>
<li><a class="reference internal" href="#contents">Contents</a><ul>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#dependencies">Dependencies</a></li>
<li><a class="reference internal" href="#development-dependencies">Development Dependencies</a><ul>
<li><a class="reference internal" href="#contributing">Contributing</a></li>
<li><a class="reference internal" href="#helpful-links">Helpful Links</a></li>
</ul>
</li>
</ul>
</div>
<div class="sphinxnext">
<h4>Next page</h4>
<p class="topless"><a href="dependencies.html"
title="Next page">→ Dependencies</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="sidebar-toggle-group no-js">
<button class="sidebar-toggle" id="sidebar-hide" title="Hide the sidebar menu">
«
<span class="show-for-small">hide menu</span>
</button>
<button class="sidebar-toggle" id="sidebar-show" title="Show the sidebar menu">
<span class="show-for-small">menu</span>
<span class="hide-for-small">sidebar</span>
»
</button>
</div>
<div class="clearer"></div>
</div>
<div class="relbar-bottom">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> </li>
<li class="right" >
<a href="dependencies.html" title="Dependencies"
>next</a> </li>
<li><a href="#">rever 0.5.0 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Rever: Releaser of Versions!</a></li>
</ul>
</div>
</div>
<div class="footer" role="contentinfo">
© Copyright 2017, Anthony Scopatz.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.4.
</div>
<!-- cloud_sptheme 1.4 -->
</body>
</html>