-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathusepatterns.html
More file actions
188 lines (150 loc) · 7.42 KB
/
usepatterns.html
File metadata and controls
188 lines (150 loc) · 7.42 KB
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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Notes for using rever — 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="News Workflow" href="news.html" />
<link rel="prev" title="Tutorial" href="tutorial.html" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="canonical" href="http://xon.sh/usepatterns.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="news.html" title="News Workflow"
accesskey="N">next</a> </li>
<li class="right" >
<a href="tutorial.html" title="Tutorial"
accesskey="P">previous</a> </li>
<li><a href="index.html">rever 0.5.0 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Notes for using rever</a></li>
</ul>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="notes-for-using-rever">
<h1>Notes for using rever<a class="headerlink" href="#notes-for-using-rever" title="Permalink to this headline">¶</a></h1>
<p>Rever is a very powerful versioning and release tool. Like all good tools
there are use patterns to maximizing your productivity.</p>
<ol class="arabic simple">
<li><p>Always commit all changes before versioning/tagging the code, since rever
will commit any changes. While rever can undo the changes it makes all
non-version changes will be lost upon a rever undo!</p></li>
<li><p>You can undo a rever command by <code class="docutils literal notranslate"><span class="pre">rever</span> <span class="pre">$version</span> <span class="pre">-u</span> <span class="pre">command1,command2</span></code></p></li>
<li><p>You will need to insert a <code class="docutils literal notranslate"><span class="pre">__version__=='a.b.c'</span></code> in the top most
<code class="docutils literal notranslate"><span class="pre">__init__.py</span></code> file.</p></li>
<li><p>You will need to change the docs <code class="docutils literal notranslate"><span class="pre">conf.py</span></code> to use the version by
importing it from the top most <code class="docutils literal notranslate"><span class="pre">__init__.py</span></code> file.</p></li>
</ol>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># The short X.Y version.</span>
<span class="n">version</span> <span class="o">=</span> <span class="n">REVER_VERSION</span><span class="o">.</span><span class="n">rsplit</span><span class="p">(</span><span class="s1">'.'</span><span class="p">,</span><span class="mi">1</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="c1"># The full version, including alpha/beta/rc tags.</span>
<span class="n">release</span> <span class="o">=</span> <span class="n">REVER_VERSION</span>
</pre></div>
</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="index.html" title="index">
<img class="logo" src="_static/longship-256.png" alt="Logo"/>
</a></p>
<div class="sphinxprev">
<h4>Previous page</h4>
<p class="topless"><a href="tutorial.html"
title="Previous page">← Tutorial</a></p>
</div>
<div class="sphinxnext">
<h4>Next page</h4>
<p class="topless"><a href="news.html"
title="Next page">→ News Workflow</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/usepatterns.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="news.html" title="News Workflow"
>next</a> </li>
<li class="right" >
<a href="tutorial.html" title="Tutorial"
>previous</a> </li>
<li><a href="index.html">rever 0.5.0 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Notes for using rever</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>